ROCCO: the Rapsodoo Original CookieCutter for Odoo

A long and durable piece of software

ROCCO is your swiss-army knife to build Docker Environments for Odoo. It has been designed to replicate odoo.sh projects locally by just providing a valid GitHub Token and the main GitHub repo. Once ROCCO has done all of its magic, you can docker-compose up a perfect replica of your odoo.sh project, submodules included. It can also be used the other way around, that is: to build a Docker Environments with an addons repo that will eventually build an odoo.sh project.

ROCCO is based on the standard Odoo Docker images, and comes with Odoo Enterprise included by default. In case you don't want to use Odoo Enterprise, just comment out the corresponding line in the Dockerfile once you have built your docker-env. In the same way, feel free to customize the resulting template at your wish if you need to change its behaviour.

Usage

Install cookiecutter:

python3 -m pip install cookiecutter

Then run cookicutter passing it the directory containing this template

python3 -m cookiecutter .

or run

cookiecutter gh:saydigital/rocco

You will be asked a few parameters, including the name and organization for both the addons repo and the docker-env repo. Then, the actual docker-env folder will be available for you. It will be automatically linked to the project addons repo you entered.

Tools

ROCCO is released with a number of tools that can help developers to manage their environments

Db Safe for Dev

This script eliminates from the database all possible configurations and data that can generate problems:

• Set admin user login and password as "admin"
• Set other users password as "test"
• Disable all the mail server
• Disable all the cron
• Change database UUID

How to use it

./tools/db-safe-for-dev.sh -d DATABASE_NAME

Restore Database

This script restore an sql file restore

How to use it

./tools/restore-db.sh -d DATABASE_NAME -f /DATABASE/RESTORE/FILE.sql

Restore Filestore

This script restore filestore files decompressed from Odoo backup

How to use it

./tools/restore-filestore.sh -d DATABASE_NAME -f /DATABASE/RESTORE/FILESTORE/PATH -r DOCKER_RUNNING_NAME

PgAdmin4

Rocco has an instance of PgAdmin4 accessible from the browser. PgAdmin4 is already auto-configured to access the odoo db.

To use it, open the url of your localhost at port :5050

Caveats

• A proxy server is not provided by the docker-compose orchestration.
• Accessing different submodules/repos with different github tokens (or with other mean of authentication) is not possible at the moment.
• Submodules are added to the odoo configuration addons_path in alphabetical order. This is meant to reproduce an undocumented feature of Odoo.sh
• The default odoo data directory is different from the one provided by the standard Odoo Docker Image. This is needed to prevent permission issues when the volume is re-declared in the composefile

FIXME

• Submodules whose path inside the addons repo don't match their GitHub repo names are not properly handled. This will be fixed in a future release.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If your code is accepted in ROCCO, please proudly add your name to the Credits section here below.

Credits

Thanks to Francesco Apruzzese for inventing the name of this long and durable piece of software.

ROCCO is based on ideas inspired by several different friend working at several different companies. Thank you all for sharing ideas, concepts, technologies and hints that brought to the creation of this tool.

Code and bugs made with ❤️ by Andrea Colangelo.

The boring stuff

Copyright 2021 © Andrea Colangelo [email protected] and Rapsodoo Italia SrL https://www.rapsodoo.com/.

ROCCO is free software, and is released under the terms of the WTFPL.

ROCCO is provided as is, without warranties of any kind. Use it at your own risk, and don't say you haven't been warned.