README.md

Doodba Copier Template

This project lets you maintain Odoo deployments based on Doodba using Copier.

Table of contents

• Installation and Usage
  • Install the dependencies
  • Use the template to generate your subproject
  • Getting updates for your subproject
• Using your subproject to build an Odoo deployment
• Getting help
• Contributing
• Credits
• Footnotes

Installation and Usage

Install the dependencies

This project itself is just the template, but you need to install these tools to use it:

• Linux¹
• copier
• Docker
  • Compose V2 plugin
• git 2.24 or newer
• invoke installed in Python 3.8.1+ (and the binary must be called invoke — beware if your distro installs it as invoke3 or similar).
• pre-commit
• python 3.8.1+
• venv

Install non-python apps with your distro's recommended package manager. The recommended way to install Python CLI apps is pipx:

python3 -m pip install --user pipx
pipx install copier
pipx install invoke
pipx install pre-commit
pipx ensurepath

Use the template to generate your subproject

Once you installed everything, you can now use Copier to copy this template:

copier copy gh:Tecnativa/doodba-copier-template ~/path/to/your/subproject

Copier will ask you a lot of questions. Answer them to properly generate the template.

Notes:

• The backup service will not be deployed when using postgresql 9.6.

Getting updates for your subproject

⚠️ If you come from doodba-scaffolding, please follow the migration guide.

If you always used Copier with this project, getting last updates with Copier is simple:

cd ~/path/to/your/downstream/scaffolding
copier update --trust

Copier will ask you all questions again, but default values will be those you answered last time. Just hit Enter to accept those defaults, or change them if needed... or you can use copier update --force --trust instead to avoid answering again all things.

Basically, read Copier docs and copier --help-all to know how to use it.

Using your subproject to build an Odoo deployment

This is a big topic documented separately.

Getting help

If your question is not answered in our FAQ or Doodba's FAQ, open an issue

Contributing

See the contribution guidelines.

Credits

This project is maintained by:

Also, special thanks to our dear community contributors.

Footnotes

¹ Any modern distro should work. Ubuntu and Fedora are officially supported. Other systems are not tested. If you're on Windows, you'll probably need WSL or a Linux VM to work with doodba without problems. If you use other systems and find a way to make these tools work, please consider opening a PR to add some docs that might help others with your situation.