Highly opinionated image ready to put Odoo inside it, but without Odoo.
Yes, the purpose of this is to serve as a base for you to build your own Odoo project, because most of them end up requiring a big amount of custom patches, merges, repositories, etc. With this image, you have a collection of good practices and tools to enable your team to have a standard Odoo project structure.
BTW, we use Alpine. I hope you like that.
Because developing Odoo is hard. You need lots of customizations, dependencies, and if you want to move from one version to another, it's a pain.
Also because nobody wants Odoo as it comes from upstream, you most likely will need to add custom patches and addons, at least, so we need a way to put all together and make it work anywhere quickly.
You can start working with this straight away with our scaffolding.
Basically, every directory you have to worry about is found inside /opt/odoo.
This is its structure:
custom/
entrypoint.d/
build.d/
conf.d/
src/
private/
odoo/
addons.txt
repos.yaml
common/
entrypoint.sh
build.sh
entrypoint.d/
build.d/
conf.d/
auto
addons/
odoo.conf
Let's go one by one.
Here you will put everything related to your project.
Any executables found here will be run when you launch your container, before running the command you ask.
Executables here will run just before those in /opt/odoo/common/build.d.
Files here will be environment-variable-expanded and concatenated in
/opt/odoo/auto/odoo.conf at build time.
Here you will put the actual source code for your project.
When putting code here, you can either:
- Use
repos.yaml, that will fill anything at build time. - Directly copy all there.
Recommendation: use repos.yaml for everything except for private,
and ignore in your .gitignore and .dockerignore files every folder here
except private, with rules like these:
odoo/custom/src/*
!odoo/custom/src/private
!odoo/custom/src/*.*
REQUIRED. The source code for your odoo project.
You can choose your Odoo version, and even merge PRs from many of them using
repos.yaml. Some versions you might consider:
-
Original Odoo, by Odoo S.A..
-
OCB (Odoo Community Backports), by OCA. The original + some features - some stability strictness.
-
OpenUpgrade, by OCA. The original, frozen at new version launch time + migration scripts.
REQUIRED. Folder with private addons for the project.
A git-aggregator configuration file.
One line per addon you want to activate in your project. Like this:
server-tools/*
website/website_legal_page
Important notes:
-
Do not add lines for the required
odooandprivatedirectories; those are automatic. -
Any other addon not listed here will not be usable in Odoo (and will be removed by default, to keep the resulting image thin).
-
In case of addon name conflict, this is the importance order in which they will be linked (from most to least important):
- Addons in
private. - Custom addons listed in
addons.txt. - Core Odoo addons from
./odoo/addons.
Although it is better to simply have no name conflicts if possible.
- Addons in
This folder is full of magic. I'll document it some day. For now, just look at the code.
Only some notes:
- Will compile your code with
PYTHONOPTIMIZE=2by default. - Will remove all code not used from the image by default (not listed in
/opt/odoo/custom/src/addons.txt), to keep it thin.
This directory will have things that are automatically generated at build time.
It will be full of symlinks to the addons you selected in addons.txt.
It will have the result of merging all configurations under
/opt/odoo/{common,custom}/conf.d/, in that order.
I will document all build arguments and environment variables some day, but for now keep this in mind:
-
This is just a base image, full of tools. You need to build your project subimage from this one, even if your project's
Dockerfileonly contains these 2 lines:FROM tecnativa/odoo-base MAINTAINER Me <[email protected]> -
The above sentence becomes true because we have a lot of
ONBUILDsentences here, so at least your project must have a./customfolder along with itsDockerfilefor it to work. -
All should be magic if you adhere to our opinions here. Just put the code where it should go, and relax.
Just a little shell script that you can use to add logs to your build or entrypoint scripts:
log INFO I'm informing
Another little shell script, useful for debugging. Just run it like this and Odoo will execute unit tests in its default database:
unittest my_addon,my_other_addon
Environment variables are there so that if you need to connect with the database, you just need to execute:
docker exec -it your_container psql
In our opinion, this is the greatest Python debugger available, mostly for Docker-based development, so here you have it preinstalled.
I told you, this image is opinionated. 😉
DO NOT USE IT IN PRODUCTION ENVIRONMENTS. (I had to say it).
We found this one to be the most useful tool for downlading code, merging it and placing it somewhere.
We use our own fork because it is even better! (Until they merge some PRs and publish a new version).
Actually, because it allows you to choose a --depth when pulling
images, and fetches only the
required remotes.
Example repos.yaml file
This example merges several sources:
./odoo:
defaults:
# Shallow repositores are faster & thinner
depth: 1000
remotes:
ocb: https://github.com/OCA/OCB.git
odoo: https://github.com/odoo/odoo.git
target:
ocb 9.0
merges:
- ocb 9.0
- odoo refs/pull/13635/head
We set an $ODOO_RC environment variable pointing to the autogenerated
configuration file so you don't have to worry about
it. Just execute odoo.py and it will work fine.
Get up and running quickly with the provided scaffolding.
I will assume you know how to use Git, Docker and Docker Compose.
git clone -b scaffolding https://github.com/Tecnativa/docker-odoo-base.git myproject
cd myproject
docker-compose -f setup-devel.yaml up
docker-compose -f devel.yaml up
And if you don't want to have a chance to do a git merge and get possible
future scaffolding updates merged in your project's git log:
rm -Rf .git
git init
The scaffolding provides you a boilerplate-ready project to start developing Odoo in no time.
This scaffolding comes with some environment configurations, ready for you to extend them. Each of them is a Docker Compose file almost ready to work out of the box (or almost), but that will assume that you understand it and will modify it.
After you clone the scaffolding, search for XXX comments, they will help
you on making it work.
Set it up with:
docker-compose -f setup-devel.yaml up
Once finished, you can start using Odoo with:
docker-compose -f devel.yaml up --build
This is on purpose. It allows you to track only what Git needs to track and provides faster Docker builds.
This environment is just a template. It is not production-ready. You must change many things inside it, it's just a guideline.
It includes pluggable smtp and backup services.
Once you fixed everything needed, run it with:
docker-compose -f prod.yaml up --build
A good rule of thumb is test in testing before uploading to production, so this environment tries to imitate the production one in everything, but removing possible pollution points:
-
It has no
smtpservice. -
It has no
backupservice.
Test it in your machine with:
docker-compose -f test.yaml up --build
Files must be executable and have no . in their name.
Of course. There's no guarantee that we will like it, but please do it. 😉
Can I have my own scaffolding?
You probably should, and rebase on our updates. However, if you are planning on a general update to it that you find interesting for the general-purpose one, please send us a pull request.
Just head to our project and open an issue or pull request.