Odoo Build
This is the Mint System Odoo development environment.
This projects provides a highly opinionated way to manage and develop Odoo. It features:
- 🔍 Odoo Source: Checkout the Odoo Community and Enterprise Edition and start editing the source code.
- 🐳 Container Compose: Spin up an Odoo, Postgres, and pgAdmin container and experiment locally.
- 💻 Native: Start an Odoo server directly from the source.
- 🔄 Multiple Versions: With Odoo Build, you can switch between Odoo versions starting from 13.0 up to 18.0.
- 🛠️ Develop Modules: Scaffold new modules, develop new Odoo features locally.
- 📥 Import and Export Database: Use Odoo scripts to copy and restore a customer database to the local environment. Investigate issues and deploy the database with ease.
- 🤝 Community Repos: The most common community repos are checked out when setting up the project.
- ✂️ Customizing Snippets: Create snippets and push them to an Odoo database.
- 🕰️ Odoo Revisions: Snapshot the Odoo source at a specific date. See revisions for details.
- 📦 Container Image: Build and publish a custom Odoo image. See README for details.
- 🔑 Credentials: Manage login credentials for Odoo and Nextcloud.
- ⬆️ Odoo Upgrade: Helper commands to ease the Odoo upgrade process.
- 🧠 LLM: Prompt LLMs with module code and apply changes.
- 🚀 And More: See task help.
Requirements
The Odoo development environment has the following requirements:
Command Completion (Optional)
bash/zsh alias task='./task' with completion.
Nix (Optional)
You can use Nix to setup the requirements.
LLM (Optional)
Install the llm cli to make use of the LLM features.
Usage
The usage section is a set of workflows. See task help or task for details about the project commands.
Clone this repository.
git clone git@github.com:Mint-System/Odoo-Build.git
cd Odoo-Build
When working with Nix, run the nix-shell.
nix-shell
Checkout the Odoo version. Show supported versions with task list-versions.
task checkout "$VERSION"
Install Odoo scripts.
task install-odoo-scripts
Decide wether you want to run Odoo in native mode (from source) or as a container.
Native
Run Odoo from source. Currently supported OS: Ubuntu, Debian, Pop!_OS, Darwin, Windows with Ubuntu on WSL2.
Setup Odoo environment
Sync the submodule branch.
task sync-git-submodule
Setup Python environment
Install packages and Python dependencies.
task install-native
Initialize and start Odoo from source
Start database container only.
task start db
Initialize database.
task init-db
Start Odoo from source.
task start native
The browser will be opened automatically.
Create a new module from source
Create a new module.
task create-module addons/project/project_sprint
Add a new model.
task generate-module-model addons/project/project_sprint project.sprint
Add model security.
task generate-module-security addons/project/project_sprint project.sprint
Load modules from thirdparty folder
Clone thirdparty repos into the thirdparty folder.
To load modules from a thirdparty folder, set this env var in your .env file:
ODOO_ADDONS_PATH=thirdparty/odoo-apps-partner-contact,../odoo-cd/untracked-odoo-apps
The paths will be appended to the Odoo config.
Initialize without demo data
In your .env file define this Odoo parameter env var:
ODOO_PARAM="--without-demo=all"
Set Odoo database name
The default database name is the checked out Odoo version.
To define another name, set this env var in your .env file:
ODOO_DATABASE=odoo
Disable browser open
To disable the browser open when starting the Odoo server edit the .env file:
BROWSER_OPEN=false
Container
Run Odoo as container.
Set podman as container engine
If you are using podman, set this .env var:
CONTAINER_ENGINE=podman
Start and initialize Odoo
Set the Odoo addons path in your .env file:
ODOO_ADDONS_PATH=/mnt/addons/,/mnt/oca/,/mnt/enterprise,/mnt/themes/
Run container compose.
task start
Initialize database with the Odoo script.
Use docker-odoo-init help to show all options.
docker-odoo-init -d odoo -i web
Open browser to http://localhost:8069 and login with admin:admin.
Common
Instructions that are true for container and native usage.
Change log level
To change the log level of Odoo set this env var in your .env file:
LOG_LEVEL=debug
Manage database with container
Open database manager http://localhost:8000/ and login with admin@example.com:admin.
Remove containers
This removes containers and volumes.
task remove
Stop all containers
task stop
Drop database
task drop-db
Define Postgres image version
Define the Postgres image in your .env file:
POSTGRES_IMAGE=postgres:12-alpine
Build and publish container image
Ensure your container setup can build multi-platform images.
Checkout latest revision of the Odoo version.
task checkout-latest-revision "16.0"
Build the Odoo image.
task build
Test the image.
task test-container
Publish the Odoo image.
task publish
Setup mail catcher
Start mail server.
task start mail
Setup mail server config for Odoo.
task setup-mail
Source env file
Assuming the name of the environment is test, you source env vars like this:
eval "$(task show-env test)"
Develop
Create Odoo revision
Check the latest official Odoo image tag on https://hub.docker.com/_/odoo/tags.
Replace the - with a . in the tag name and create a revision:
task create-revision 16.0.20250311
Replace all image references in the docs.
Update repo template from oca-addons-repo-template
Install copier.
source task source
uv pip install copier
Run copier and select ruff as linter.
copier copy --UNSAFE https://github.com/OCA/oca-addons-repo-template.git "templates/$VERSION"
Remove unnecessary linter files.
cd "templates/$VERSION"
rm -rf .github
rm .copier-answers.yml
rm .flake8
rm .isort.cfg
rm .pylintrc-mandatory
rm README.md
In .pre-commit-config.yaml remove mandatory pylint odoo:
- id: pylint_odoo
args:
- --rcfile=.pylintrc-mandatory
In .pylintrc remove these rules:
- missing-return
- duplicate-xml-record-id
- redefined-builtin
In the .ruff.toml set this option:
line-length = 120
Template the server tools repo and run the linter:
task template-repo addons/server_tools
cd addons/server_tools
task all
Refine the templates based on the linter results.