The easiest way to install and manage development odoo instances / projects.
Master | |||
---|---|---|---|
Dev |
This project aims to simplify development process of Odoo addons as much as possible.
odoo-helper-scripts will do all routine operations for you:
If you have any routine operation that you would like to automate with odoo-helper-scripts, just fill an issue or do pull request, and may be that feature will be available in one of next releases.
WARNING: If you want to deploy production-ready odoo server, please, read carefully Usage notes section.
2022-02-24 Russia invaded Ukraine...
If you want to help or support Ukraine to stand against russian inavasion, please, visit the official site of Ukraine and find the best way to do it.
Thanks.
The canonical source of odoo-helper-scripts is hosted on GitLab.
Note Documentaion in this readme, or in other sources, may not be up to date!!!
So use --help
option, which is available for most of commands.
This script collection is designed to simplify life of addons developer. This project is not designed, to install and configure production ready Odoo instances, unless you know what you do!
For production-ready installations take a look at crnd-deploy project - just a single command allows you to get production-ready odoo instance with configured PostgreSQL and Nginx.
Also take a look at Yodoo Cockpit project, and discover the easiest way to manage your production Odoo installations with automated billing and support of custom addons.
Just short notes about Yodoo Cockpit:
Level up your service quality with Helpdesk / Service Desk / ITSM solution by CR&D.
Just test it at yodoo.systems: choose template you like, and start working.
Test all available features of Bureaucrat ITSM with this template.
For full list of installation options look at installation documentation
Basically, odoo-helper could be installed in two way:
To install odoo-helper-scripts system-wide (the recommended way) do folowing:
# Install odoo-helper-scripts
wget -O - https://gitlab.com/katyukha/odoo-helper-scripts/raw/master/install-system.bash | sudo bash -s
# Install system dependencies required for odoo-helper-scripts
# NOTE: Works only on debian-based systems
odoo-helper install pre-requirements
or more explicit way:
# Download installation script
wget -O /tmp/odoo-helper-install.bash https://gitlab.com/katyukha/odoo-helper-scripts/raw/master/install-system.bash;
# Install odoo-helper-scripts
sudo bash /tmp/odoo-helper-install.bash;
# Intall system pre-requirements for odoo-helper-scripts
# NOTE: Works only on debian-based systems
odoo-helper install pre-requirements
Also, you can install odoo-helper-scripts as debian package. See releases page. To install the latest stable version just download and install following deb package: odoo-helper-scripts_master.deb
It is possible to run basic tests via docker.
For this task, odoo-helper-scripts repo contains script scripts/run_docker_test.bash
.
Run bash scripts/run_docker_test.bash --help
to see all available options for that script.
For example to test, how odoo-helper-scripts will work on debian:stretch, do following:
cd $ODOO_HELPER_ROOT
bash scripts/run_docker_test.bash --docker-ti --docker-image debian:stretch
Note, running tests may take more then 1:30 hours.
And after install you will have available folowing scripts in your path:
Each script have -h
or --help
option which display most relevant information
about script and all possible options and subcommands of script
Also there are some aliases for common commands:
For more info look at documentation. (currently documentation status is work-in-progress). Also look at Frequently used commands and Command reference
Also look at odoo-helper-scripts tests to get complete usage example (look for Start test comment).
Have you any quetions? Just fill an issue or send email