Merge pull request #22 from norlinhenrik/main-readme-prod-env

[IMP] README.md: production: Update .env SERVICES and ACME_CA_URI

.env.example

@@ -8,9 +8,10 @@ UPDATE=
 LOAD=base,web
 ROOT_PATH=/usr/lib/python3/dist-packages/odoo
 WORKERS=0
-DEV_MODE=reload,xml
 DOMAIN=erp.odoocker.test
 ADMIN_PASSWD=odoo
+# Use reload,xml to enable hot reload in python and xml files
+DEV_MODE=
 
 # Services
 PROJECT_NAME=odoocker
@@ -22,10 +23,14 @@ USE_S3=false
 USE_SENTRY=false
 USE_PGADMIN=false
 
-# Enterprise
+# GitHub user and access token to clone private repositories
 GITHUB_USER=
 GITHUB_ACCESS_TOKEN=
 
+# GitHub user and access token to clone Enterprise repository
+ENTERPRISE_USER=${GITHUB_USER}
+ENTERPRISE_ACCESS_TOKEN=${GITHUB_ACCESS_TOKEN}
+
 # Database
 DB_HOST=postgres
 DB_PORT=5432
@@ -114,6 +119,7 @@ PGADMIN_DB_HOST="'postgresql://${PGADMING_DB_USER}:${PGADMIN_DB_PASSWORD}@${DB_H
 PGADMIN_EMAIL=pgadmin@example.com
 PGADMIN_PASSWORD=pgadmin
 
+# To import servers use /pgadmin4/servers.json on first build, then remove.
 PGADMIN_SERVERS_JSON=
 PGADMIN_CONFIG_SERVER_MODE=True
 
@@ -144,14 +150,14 @@ MINIO_PROFILES="minio"
 PGADMIN_PROFILES="pgadmin"
 
 # Containers' Tags
-ODOO_TAG=16.0
+ODOO_TAG=17.0
 POSTGRES_TAG=16.1
 KEYDB_TAG=latest
 MINIO_TAG=latest
 NGINX_TAG=1.25.3
 NGINX_PROXY_TAG=1.4.0
 ACME_COMPANION_TAG=2.2.9
-PGADMIN_TAG=8.0
+PGADMIN_TAG=8.1
 
 # Odoocker paths
 COMMUNITY_ADDONS=${ROOT_PATH}/addons

README.md

@@ -43,6 +43,7 @@ In essence, Odoocker isn't just another tool, it's a philosophy. So, whether you
 1. **Clone and Configure**:
 ```
 git clone git@github.com:odoocker/odoocker.git
+cd odoocker
 cp .env.example .env && cp docker-compose.override.local.yml docker-compose.override.yml
 ```
 2. **Hosts & Domains**: To ensure everything runs smoothly, remember to add the necessary domains to your hosts file.
@@ -155,6 +156,7 @@ docker-compose down
 ```
 cp docker-compose.override.production.yml docker-compose.override.yml
 ```
+- Update .env `SERVICES` (add `acme`) and `ACME_CA_URI` (use production link).
 - Make sure the DNS record of your `DOMAIN` is pointing to your server.
 - Rebuild the containers
 ```

docker-compose.override.local.yml

@@ -20,3 +20,15 @@ services:
     ports:
       - 80:80
       - 443:443
+
+  letsencrypt:
+    restart: 'no'
+
+  redis:
+    restart: 'no'
+
+  s3:
+    restart: 'no'
+
+  pgadmin:
+    restart: 'no'

docker-compose.override.production.yml

@@ -20,3 +20,15 @@ services:
     ports:
       - 80:80
       - 443:443
+
+  letsencrypt:
+    restart: unless-stopped
+
+  redis:
+    restart: unless-stopped
+
+  s3:
+    restart: unless-stopped
+
+  pgadmin:
+    restart: unless-stopped

docker-compose.yml

@@ -7,9 +7,11 @@ services:
         - ODOO_TAG
         - ODOO_RC
         - ROOT_PATH
+        - ENTERPRISE_USER
+        - ENTERPRISE_ACCESS_TOKEN
+        - ENTERPRISE_ADDONS
         - GITHUB_USER
         - GITHUB_ACCESS_TOKEN
-        - ENTERPRISE_ADDONS
         - THIRD_PARTY_ADDONS
         - LOG_PATH
         - USE_REDIS
@@ -58,7 +60,6 @@ services:
       dockerfile: ./postgres/Dockerfile
       args:
         - POSTGRES_TAG
-    restart: unless-stopped
     tty: true
     volumes:
       - pg-data:${PGDATA}
@@ -82,7 +83,6 @@ services:
     image: nginx:${NGINX_TAG}
     depends_on:
       - odoo
-    restart: unless-stopped
     tty: true
     expose:
       - 80/tcp
@@ -102,7 +102,6 @@ services:
     image: nginxproxy/nginx-proxy:${NGINX_PROXY_TAG}
     depends_on:
       - nginx
-    restart: unless-stopped
     tty: true
     volumes:
       - ./nginx-proxy/nginx.conf:${NGINX_CONF}
@@ -118,12 +117,29 @@ services:
       - internal
     profiles: [$NGINX_PROXY_PROFILES]
 
+  letsencrypt:
+    image: nginxproxy/acme-companion:${ACME_COMPANION_TAG}
+    depends_on:
+      - nginx-proxy
+    volumes_from:
+      - nginx-proxy:rw
+    volumes:
+      - certs:${NGINX_CERTS}:rw
+      - acme:${NGINX_ACME}
+      - ${DOCKER_SOCK}:${DOCKER_SOCK}:ro
+    environment:
+      - ACME_CA_URI
+      - CERTS_UPDATE_INTERVAL
+      - DEFAULT_EMAIL
+    networks:
+      - internal
+    profiles: [$ACME_COMPANION_PROFILES]
+
   redis:
     image: eqalpha/keydb:${KEYDB_TAG}
     platform: linux/amd64
     ports:
       - ${KEYDB_PORT}:${KEYDB_PORT}
-    restart: unless-stopped
     volumes:
       - redis-data:${KEYDB_DATA}
     networks:
@@ -148,32 +164,14 @@ services:
       - internal
     profiles: [$MINIO_PROFILES]
 
-  letsencrypt:
-    image: nginxproxy/acme-companion:${ACME_COMPANION_TAG}
-    depends_on:
-      - nginx-proxy
-    restart: unless-stopped
-    volumes_from:
-      - nginx-proxy:rw
-    volumes:
-      - certs:${NGINX_CERTS}:rw
-      - acme:${NGINX_ACME}
-      - ${DOCKER_SOCK}:${DOCKER_SOCK}:ro
-    environment:
-      - ACME_CA_URI
-      - CERTS_UPDATE_INTERVAL
-      - DEFAULT_EMAIL
-    networks:
-      - internal
-    profiles: [$ACME_COMPANION_PROFILES]
-
   pgadmin:
     build:
       context: ./
       dockerfile: ./pgadmin/Dockerfile
       args:
         - PGADMIN_TAG
-    restart: 'no'
+    depends_on:
+      - nginx-proxy
     expose:
       - 80
     volumes:

odoo/Dockerfile

@@ -11,9 +11,11 @@ USER root
 ARG ODOO_TAG
 ARG ROOT_PATH
 ARG LOG_PATH
+ARG ENTERPRISE_USER
+ARG ENTERPRISE_ACCESS_TOKEN
+ARG ENTERPRISE_ADDONS
 ARG GITHUB_USER
 ARG GITHUB_ACCESS_TOKEN
-ARG ENTERPRISE_ADDONS
 ARG THIRD_PARTY_ADDONS
 ARG ODOO_RC
 ARG USE_REDIS
@@ -22,80 +24,67 @@ ARG USE_SENTRY
 
 ENV ODOO_TAG=${ODOO_TAG} \
     LOG_PATH=${LOG_PATH} \
+    ENTERPRISE_USER=${ENTERPRISE_USER} \
+    ENTERPRISE_ACCESS_TOKEN=${ENTERPRISE_ACCESS_TOKEN} \
+    ENTERPRISE_ADDONS=${ENTERPRISE_ADDONS} \
     GITHUB_USER=${GITHUB_USER} \
     GITHUB_ACCESS_TOKEN=${GITHUB_ACCESS_TOKEN} \
-    ENTERPRISE_ADDONS=${ENTERPRISE_ADDONS} \
     THIRD_PARTY_ADDONS=${THIRD_PARTY_ADDONS} \
     ODOO_RC=${ODOO_RC} \
     USE_REDIS=${USE_REDIS} \
     USE_S3=${USE_S3} \
     USE_SENTRY=${USE_SENTRY}
 
+#---------------------#
+#       Logging       #
+#---------------------#
+# Create odoo.log file
+RUN touch ${LOG_PATH} && chown odoo:odoo ${LOG_PATH}
+
 #------------------------#
 #    APT Dependencies    #
 #------------------------#
+# Install Odoocker image dependencies
 RUN apt-get update && apt-get install -y \
-    apt-utils \
+    # `zip` and `unzip` for filestore management
+    zip \
+    unzip \
+    # `git` required packages
     git \
     git-man \
     less \
-    libcbor0 \
+    libcbor0.8 \
     libcurl3-gnutls \
     libedit2 \
     liberror-perl \
+    libfido2-1 \
     libxmuu1 \
     openssh-client \
     patch \
     xauth \
-    # Clean up the apt cache to reduce the image size
+    # Remove apt lists
     && rm -rf /var/lib/apt/lists/*
 
 #---------------------#
 #   PIP Dependecies   #
 #---------------------#
-# Upgrade pip
-RUN pip3 install --upgrade pip
-
 # Copy & Install PIP requirements
 COPY --chown=odoo:odoo ./odoo/requirements.txt /tmp/requirements.txt
 
 RUN python3 -m pip install -r /tmp/requirements.txt && \
     rm /tmp/requirements.txt
 
-#-----------------------#
+#--------------------------------------------#
-#    Odoo Enterprise    #
+#    Odoo Enterprise + Third Party Addons    #
-#-----------------------#
+#--------------------------------------------#
-
+# Create third-party-addons directory and clone them
-# Create Enterprise addons directory
+COPY --chown=odoo:odoo ./odoo/clone-addons.sh /
-RUN mkdir -p ${ENTERPRISE_ADDONS} && \
+COPY --chown=odoo:odoo ./odoo/third-party-addons.txt /
-    chown odoo:odoo -R ${ENTERPRISE_ADDONS}
+RUN /clone-addons.sh
-
-# Clone Enterprise addons if user and token are present
-RUN if [ -n "$GITHUB_USER" ] && [ -n "$GITHUB_ACCESS_TOKEN" ]; then \
-        git clone https://${GITHUB_USER}:${GITHUB_ACCESS_TOKEN}@github.com/odoo/enterprise.git ${ENTERPRISE_ADDONS} --depth 1 --branch ${ODOO_TAG} --single-branch --no-tags; \
-    fi
-
-#-------------------------#
-#    Odoo Extra Addons    #
-#-------------------------#
-
-RUN mkdir -p ${THIRD_PARTY_ADDONS} && chown odoo:odoo -R ${THIRD_PARTY_ADDONS}
-
-COPY --chown=odoo:odoo ./odoo/fix-manifest.py /
-COPY --chown=odoo:odoo ./odoo/third-party-addons.sh /
-RUN /third-party-addons.sh && chown odoo:odoo -R ${THIRD_PARTY_ADDONS}
-
-#---------------------#
-#       Logging       #
-#---------------------#
-
-# Create odoo.log file
-RUN touch ${LOG_PATH} && chown odoo:odoo ${LOG_PATH}
 
 #-----------------------#
 #       Odoo Conf       #
 #-----------------------#
-
 # Copy environment variables & script to generate odoo.conf
 COPY --chown=odoo:odoo ./.env /
 COPY --chown=odoo:odoo ./odoo/odoo.conf /

odoo/clone-addons.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+set -e
+
+# Function to construct the clone command
+construct_clone_command() {
+    local repo_type=$1
+    local repo_url=$2
+    case $repo_type in
+        private) echo "git clone https://${GITHUB_USER}:${GITHUB_ACCESS_TOKEN}@${repo_url#https://}" ;;
+        enterprise) echo "git clone https://${ENTERPRISE_USER}:${ENTERPRISE_ACCESS_TOKEN}@${repo_url#https://} ${ENTERPRISE_ADDONS}" ;;
+        public) echo "git clone $repo_url" ;;
+    esac
+}
+
+# Function to clone and copy modules based on conditions
+clone_and_copy_modules() {
+    local repo_type=$1
+    local repo_url=$2
+    local clone_cmd=$(construct_clone_command $repo_type $repo_url)
+    local repo_name=$(basename -s .git "$repo_url")
+
+    shift 2
+    local modules_conditions=("$@")
+
+    # Clone and copy logic for enterprise repository
+    if [[ $repo_type == "enterprise" ]]; then
+        if [ -n "$GITHUB_USER" ] && [ -n "$GITHUB_ACCESS_TOKEN" ]; then
+            $clone_cmd --depth 1 --branch ${ODOO_TAG} --single-branch --no-tags
+        fi
+    else
+        # Determine if any module has a true condition
+        local should_clone=false
+        if [[ ${#modules_conditions[@]} -eq 1 ]]; then
+            [[ ${modules_conditions[0]} == true ]] && should_clone=true
+        else
+            for (( i=1; i<${#modules_conditions[@]}; i+=2 )); do
+                if [[ ${modules_conditions[i]} == true ]]; then
+                    should_clone=true
+                    break
+                fi
+            done
+        fi
+
+        # Clone the repo if should_clone is true and it's not already cloned
+        if [[ $should_clone == true && ! -d "$repo_name" ]]; then
+            $clone_cmd --depth 1 --branch ${ODOO_TAG} --single-branch --no-tags
+        fi
+
+        # Copy the modules if the condition is true
+        if [[ $should_clone == true ]]; then
+            for (( i=0; i<${#modules_conditions[@]}; i+=2 )); do
+                local module=${modules_conditions[i]}
+                local condition=${modules_conditions[i+1]}
+                if [[ $condition == true ]]; then
+                    echo "Copying ${module} from ${repo_name} into ${THIRD_PARTY_ADDONS}"
+                    cp -r /${repo_name}/${module} ${THIRD_PARTY_ADDONS}/${module}
+                fi
+            done
+        fi
+    fi
+}
+
+# Function to manually expand environment variables in a string
+expand_env_vars() {
+    while IFS=' ' read -r -a words; do
+        for word in "${words[@]}"; do
+            if [[ $word == \$\{* ]]; then
+                # Remove the leading '${' and the trailing '}' from the word
+                varname=${word:2:-1}
+                # Check if the variable is set and not empty
+                if [ -n "${!varname+x}" ]; then
+                    echo -n "${!varname} " # Substitute with its value
+                else
+                    echo -n "false " # Default to false if not set
+                fi
+            else
+                echo -n "$word "
+            fi
+        done
+        echo
+    done <<< "$1"
+}
+
+# Read the configuration file and process each line
+while IFS= read -r line; do
+    mkdir -p ${ENTERPRISE_ADDONS}
+    mkdir -p ${THIRD_PARTY_ADDONS}
+    [[ -z "$line" || "$line" == \#* ]] && continue
+    clone_and_copy_modules $(expand_env_vars "$line")
+done < "third-party-addons.txt"

odoo/custom-addons/DELETE_ME.txt

@@ -1 +1 @@
-Delete me once you add your first custom addon :)
+Delete me once you add your first custom addon :)

odoo/entrypoint.sh

@@ -71,14 +71,14 @@ case "$1" in
                 # Automagically upgrade all addons and install new ones. Ideal for deployment process.
                 echo odoo --config ${ODOO_RC} --database=${DB_NAME} --init=${INIT} --update=all --load=${LOAD} --log-level=${LOG_LEVEL} --load-language=${LOAD_LANGUAGE} --limit-time-cpu=3600 --limit-time-real=7200 --dev=
 
-                exec odoo --config ${ODOO_RC} --update=all --without-demo=all --workers=0 --limit-time-cpu=3600 --limit-time-real=7200 --dev=
+                exec odoo --config ${ODOO_RC} --database=${DB_NAME} --init=${INIT} --update=all --without-demo=all --workers=0 --limit-time-cpu=3600 --limit-time-real=7200 --dev=
             fi
 
             if [ ${APP_ENV} = 'production' ] ; then
                 # Bring up Odoo ready for production.
-                echo odoo --config ${ODOO_RC} --database=${DB_NAME} --init=${INIT} --update=${UPDATE} --load=${LOAD} --workers=${WORKERS} --log-level=${LOG_LEVEL} --without-demo=${WITHOUT_DEMO} --load-language= --dev=
+                echo odoo --config ${ODOO_RC} --database= --init=${INIT} --update=${UPDATE} --load=${LOAD} --workers=${WORKERS} --log-level=${LOG_LEVEL} --without-demo=${WITHOUT_DEMO} --load-language= --dev=
 
-                exec odoo --config ${ODOO_RC} --init=${INIT} --update=${UPDATE} --load-language= --dev=
+                exec odoo --config ${ODOO_RC} --database= --init=${INIT} --update=${UPDATE} --load-language= --dev=
             fi
         fi
         ;;

odoo/extra-addons/DELETE_ME.txt

@@ -0,0 +1,2 @@
+Delete me once you add your first extra addon :)
+This folder is made for addons that are not clonable via GitHub.

odoo/extra-addons/odoocker_base/__manifest__.py

@@ -1,24 +0,0 @@
-{
-    'name': 'Odoocker Base',
-    'summary': 'Supercharge Odoo with Odoocker',
-    'description': '''
-        Some Odoocker dependencies require to some custom values that we cover with this Addon for you.
-    ''',
-    'version': '1.0.0',
-    'category': 'Technical',
-    'license': 'LGPL-3',
-    'author': 'Odoocker',
-    'maintainer': 'Odoocker',
-    'contributors': [
-        'Yhael S <yhaelopez@gmail.com>'
-    ],
-    'depends': [
-        'base'
-    ],
-    'data': [
-        'data/ir_config_parameter.xml'
-    ],
-    'application': False,
-    'installable': True,
-    'auto_install': True
-}

odoo/extra-addons/odoocker_base/data/ir_config_parameter.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<odoo>
-    <!-- When initializing Odoo through Docker this parameter is missing. -->
-    <record id="report_url" model="ir.config_parameter">
-        <field name="key">report.url</field>
-        <field name="value">http://127.0.0.1:8069</field>
-    </record>
-
-    <!-- When initializing Odoo with S3 storage. -->
-    <record id="ir_attachment_location" model="ir.config_parameter">
-        <field name="key">ir_attachment.location</field>
-        <field name="value">s3</field>
-    </record>
-</odoo>

odoo/fix-manifest.py

@@ -1,34 +0,0 @@
-import sys
-
-# Define the path to the manifest file
-manifest_file_path = sys.argv[1]
-
-# Read the file content
-with open(manifest_file_path, 'r') as file:
-    lines = file.readlines()
-
-# Find the start and end index of the manifest dictionary
-start_index = next(i for i, line in enumerate(lines) if line.strip().startswith('{'))
-end_index = next(i for i, line in enumerate(lines) if line.strip().endswith('}'))
-
-# Construct and evaluate the manifest dictionary
-manifest_dict = eval(''.join(lines[start_index:end_index + 1]))
-
-# Modify the manifest dictionary
-manifest_dict['installable'] = True
-manifest_dict['auto_install'] = True
-
-# Construct the modified manifest string
-modified_manifest_lines = ['{\n']
-for key, value in manifest_dict.items():
-    modified_manifest_lines.append(f"    '{key}': {repr(value)},\n")
-modified_manifest_lines.append('}\n')
-
-# Replace the manifest dictionary string in the content
-lines[start_index:end_index + 1] = modified_manifest_lines
-
-# Write the modified content back to the file
-with open(manifest_file_path, 'w') as file:
-    file.writelines(lines)
-
-print(f"Modified {manifest_file_path}")

odoo/odoo.conf

@@ -64,7 +64,7 @@ xmlrpcs_interface = ${XMLRPCS_INTERFACE}
 ; --xmlrpcs-port
 xmlrpcs_port = ${XMLRPCS_PORT}
 
-; --gevent-port | --longpolling-port (deprecated)
+; --gevent-port
 gevent_port = ${GEVENT_PORT}
 
 ; --no-http | --no-xmlrpc
@@ -226,7 +226,7 @@ stop_after_init = ${STOP_AFTER_INIT}
 ; --osv-memory-count-limit
 osv_memory_count_limit = ${OSV_MEMORY_COUNT_LIMIT}
 
-; --transient-age-limit | --osv-memory-age-limit (deprecated)
+; --transient-age-limit
 transient_age_limit = ${TRANSIENT_AGE_LIMIT}
 
 ; --max-cron-threads

odoo/requirements.txt

@@ -2,4 +2,4 @@ debugpy
 websocket-client
 redis
 boto3
-sentry-sdk
+sentry-sdk==1.9.0 # Fixed because Odoo depends on urllib3==1.26.5

odoo/third-party-addons.sh

@@ -1,24 +0,0 @@
-#!/bin/bash
-
-set -e
-
-# Check if the repository directory exists and either Redis or S3 is to be used
-if [[ ${USE_REDIS} == "true" || ${USE_S3} == "true" ]]; then
-    git clone https://github.com/odoocker/odoo-cloud-platform.git --depth 1 --branch ${ODOO_TAG} --single-branch --no-tags;
-fi
-
-if [[ ${USE_REDIS} == "true" ]]; then
-    cp -r odoo-cloud-platform/session_redis ${THIRD_PARTY_ADDONS}/session_redis
-fi
-
-# Check the USE_S3 variable to decide whether to copy S3 directories
-if [[ ${USE_S3} == "true" ]]; then
-    cp -r odoo-cloud-platform/base_attachment_object_storage ${THIRD_PARTY_ADDONS}/base_attachment_object_storage
-    cp -r odoo-cloud-platform/attachment_s3 ${THIRD_PARTY_ADDONS}/attachment_s3
-fi
-
-# Check if the repository directory exists and Sentry is to be used
-if [[ ${USE_SENTRY} == "true" ]]; then
-    git clone https://github.com/odoocker/server-tools.git --depth 1 --branch ${ODOO_TAG} --single-branch --no-tags;
-    cp -r server-tools/sentry ${THIRD_PARTY_ADDONS}/sentry
-fi

odoo/third-party-addons.txt

@@ -0,0 +1,18 @@
+# This file is read by clone-addons.sh
+
+# Enterprise addons
+enterprise https://github.com/odoo/enterprise true
+
+# Odoocker repositories
+public https://github.com/odoocker/odoocker-modules.git odoocker_base true
+public https://github.com/odoocker/odoo-cloud-platform.git session_redis ${USE_REDIS} base_attachment_object_storage ${USE_S3} attachment_s3 ${USE_S3}
+public https://github.com/odoocker/server-tools.git sentry ${USE_SENTRY}
+
+# Add repositories with the following format:
+# <public|private> <repo_url> <true|false>
+# or
+# <public|private> <repo_url> <module1> <true|false> <module2> <true|false> ...
+
+# Public repositories
+
+# Private repositories