Template for an Odoo 17 Project

Table of Contents

• Prerequisites
• Build your environment
  • For private modules
  • For existing public modules
  • For new public modules
• Deploy
• Tests
• Environment Variables
• Issues

Prerequisites

Look at the INSTALL file.

Build your environment

Go to the root directory of the cloned Github repository and run:

docker-compose build

To start Odoo:

docker-compose up

For private modules

• Create a new branch and add your module in odoo/src/private-addons
• Add your module as a dependency of the customer module
• Commit, push your branch and create a pull request against master

For existing public modules

Modules must be available on Pypi, otherwise look at the next section.

• Create a new branch
• Add the module in odoo/requirements.txt
• Add the module as a dependency of the customer module
• Commit, push your branch and create a pull request against master

For new public modules

• In Github, fork the repo in the ursais organization
• Add the repo as a submodule:

git submodule add --name repo -b 16.0 https://github.com/ursais/repo.git
odoo/src/repo

• Create a new branch in odoo/src/ and add your module
• Commit your changes and push your module to Github
• In Github (https://github.com/ursais), create a pull request against the corresponding OCA repository
• Add a section (1 per repo) in repos.yml and include your pull request
• Run Git Aggregator:

gitaggregate -c repos.yml -p -j 10

• Add your module as a dependency of the customer module
• Add your module in odoo/Dockerfile
• Commit, push your branch and create a pull request against master

Deploy

Look at the helm/README.md file.

Tests

• For functional tests using Selenium, please go to odoo/tests/selenium.
• For performance tests using Locust, please go to odoo/tests/locust.

Environment Variables

General

Name	Description	Default Value
RUNNING_ENV	Set to replicate what type of migration will occur. Options are production (create, migrate), qa (upgrade existing, duplicate), test (upgrade existing, duplicate), dev (drop latest, create, migrate). Anything else will not trigger migration	dev
PLATFORM	Used to identify the cloud provider: aws, azure, do or local	do
APP_IMAGE_VERSION	Used to set the version of the image	latest
DEBUG	Display debugging information if set to 1

Description: A list of variables that have default values when not set in docker-compose.yml. These environment variables can be altered to directly impact configurations of the build when using docker-compose up

Odoo

Name	Description	Default Value
ODOO_ADDONS_PATH	Value set in odoo.conf for: addons_path	/odoo/addons
ODOO_ADMIN_PASSWD	Value set in odoo.conf for: admin_passwd	admin
ODOO_CSV_INTERNAL_SEP	Value set in odoo.conf for: csv_internal_sep	,
ODOO_DATA_DIR	Value set in odoo.conf for: data_dir	/odoo/data
ODOO_DBFILTER	Value set in odoo.conf for: dbfilter	^[^backup|defaultdb].*$
PGHOST	Value set in odoo.conf for: db_host	db
ODOO_DB_MAXCONN	Value set in odoo.conf for: db_maxconn	64
PGDATABASE	Value set in odoo.conf for: db_name	False
PGPASSWORD	Value set in odoo.conf for: db_password	odoo
PGPORT	Value set in odoo.conf for: db_port	5432
PGSSLMODE	Value set in odoo.conf for: db_sslmode	prefer
ODOO_DB_TEMPLATE	Value set in odoo.conf for: db_template	template0
PGUSER	Value set in odoo.conf for: db_user	odoo
ODOO_DEMO	Value set in odoo.conf for: demo	{}
ODOO_EMAIL_FROM	Value set in odoo.conf for: email_from	False
ODOO_GEOIP_DATABASE	Value set in odoo.conf for: geoip_database	/usr/share/GeoIP/GeoLite2-City.mmdb
ODOO_HTTP_ENABLE	Value set in odoo.conf for: http_enable	True
ODOO_HTTP_INTERFACE	Value set in odoo.conf for: http_interface
ODOO_IMPORT_PARTIAL	Value set in odoo.conf for: import_partial
ODOO_LIMIT_MEMORY_HARD	Value set in odoo.conf for: limit_memory_hard	4294967296
ODOO_LIMIT_MEMORY_SOFT	Value set in odoo.conf for: limit_memory_soft	2147483648
ODOO_LIMIT_REQUEST	Value set in odoo.conf for: limit_request	8192
ODOO_LIMIT_TIME_CPU	Value set in odoo.conf for: limit_time_cpu	1800
ODOO_LIMIT_TIME_REAL_CRON	Value set in odoo.conf for: limit_time_real_cron	120
ODOO_LIMIT_TIME_REAL	Value set in odoo.conf for: limit_time_real	1800
ODOO_LIST_DB	Value set in odoo.conf for: list_db	False
ODOO_LOG_DB	Value set in odoo.conf for: log_db	False
ODOO_LOG_DB_LEVEL	Value set in odoo.conf for: log_db_level	warning
ODOO_LOGFILE	Value set in odoo.conf for: logfile	None
ODOO_LOG_HANDLER	Value set in odoo.conf for: log_handler	:INFO
ODOO_LOG_LEVEL	Value set in odoo.conf for: log_level	info
ODOO_LOGROTATE	Value set in odoo.conf for: logrotate	False
ODOO_MAX_CRON_THREADS	Value set in odoo.conf for: max_cron_threads	1
ODOO_OSV_MEMORY_COUNT_LIMIT	Value set in odoo.conf for: osv_memory_count_limit	False
ODOO_PG_PATH	Value set in odoo.conf for: pg_path
ODOO_PIDFILE	Value set in odoo.conf for: pidfile
ODOO_PROXY_MODE	Value set in odoo.conf for: proxy_mode	True
ODOO_REPORTGZ	Value set in odoo.conf for: reportgz	False
ODOO_SCREENCASTS	Value set in odoo.conf for: screencasts	False
ODOO_SCREENSHOTS	Value set in odoo.conf for: screenshots	/tmp/odoo_tests
ODOO_SERVER_WIDE_MODULES	Value set in odoo.conf for: server_wide_modules	web,monitoring_status
ODOO_SMTP_PASSWORD	Value set in odoo.conf for: smtp_password	False
ODOO_SMTP_PORT	Value set in odoo.conf for: smtp_port	25
ODOO_SMTP_SERVER	Value set in odoo.conf for: smtp_server	localhost
ODOO_SMTP_SSL	Value set in odoo.conf for: smtp_ssl	False
ODOO_SMTP_USER	Value set in odoo.conf for: smtp_user	False
ODOO_SYSLOG	Value set in odoo.conf for: syslog	False
ODOO_TEST_ENABLE	Value set in odoo.conf for: test_enable	False
ODOO_TEST_FILE	Value set in odoo.conf for: test_file
ODOO_TEST_TAGS	Value set in odoo.conf for: test_tags	None
ODOO_TRANSLATE_MODULES	Value set in odoo.conf for: translate_modules	['all']
ODOO_TRANSIENT_AGE_LIMIT	Value set in odoo.conf for: transient_age_limit	1.0
ODOO_UNACCENT	Value set in odoo.conf for: unaccent	False
ODOO_UPGRADE_PATH	Value set in odoo.conf for: upgrade_path
ODOO_WITHOUT_DEMO	Value set in odoo.conf for: without_demo	all
ODOO_WORKERS	Value set in odoo.conf for: workers	3
ODOO_XMLRPC_INTERFACE	Value set in odoo.conf for: xmlrpc_interface

Odoo filestore and Rclone

Name	Description	Default Value
PLATFORM	Used to identify the cloud provider: aws, azure, do or local	do
AWS_HOST	Value for Aws host URL	false
AWS_REGION	Set value if using AWS platform for cloud filestore
AWS_ACCESS_KEY_ID	Access key set for connection to AWS cloud filestore bucket
AWS_SECRET_ACCESS_KEY	Secret key set for connection to AWS cloud filtestore bucket
AZURE_STORAGE_CONNECTION_STRING	Value for Azure connection string	false
AZURE_STORAGE_ACCOUNT_URL	Set value if using azure platform for cloud filestore
AZURE_STORAGE_ACCOUNT_KEY	Value for Azure storage account key	false
AWS_DUPLICATE	Set value to true to duplicate filestore with database
AWS_EMPTY_ON_DBDROP	Set value to true to remove contents from filestore bucket when dropping db

PostgreSQL

Name	Description	Default Value
PGHOST	Value set in odoo.conf for: db_host	db
PGPORT	Value set in odoo.conf for: db_port	5432
PGUSER	Value set in odoo.conf for: db_user	odoo
PGPASSWORD	Value set in odoo.conf for: db_password	odoo
PGDATABASE	Value set in odoo.conf for: db_name	False
PGSSLMODE	Value set in odoo.conf for: db_sslmode	prefer

Marabunta

Name	Description	Default Value
RUNNING_ENV	Set to replicate what type of migration will occur. Options are production (create, migrate), qa (upgrade existing, duplicate), test (upgrade existing, duplicate), dev (drop latest, create, migrate). Anything else will not trigger migration	dev
APP_IMAGE_VERSION	Used to set a custom database name on migration	latest
MARABUNTA_MODE	The mode controls what operations should occur based off its value of external(serverside) or base(General)	base
MARABUNTA_ALLOW_SERIE	Allows multiple versions to upgrade	false
MARABUNTA_FORCE_VERSION	Force a specific version to be re-ran

Anthem

Name	Description	Default Value
ODOO_DATA_PATH	Set the path to the csv files	/odoo/songs/data

Issues

Report any issue to this Github project.