mathben/erplibre
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions
erplibre/doc/PRODUCTION.base.md

12 KiB
Raw Permalink Blame History

ERPLibre production guide

Requirement

  • 5Go of disk space

Production installation procedure

1. Clone the project:

Guide de production ERPLibre

Prérequis

  • 5 Go d'espace disque

Procédure d'installation en production

1. Cloner le projet :

git clone https://github.com/ERPLibre/ERPLibre.git
cd ERPLibre

2. Modify the parameters

Modify the file env_var.sh for production installation. Enable nginx if you need a proxy with EL_INSTALL_NGINX at True. Redirect your DNS to the proxy's ip and add your A and AAAA into EL_WEBSITE_NAME with space between.

3. Execute the scripts:

With proxy nginx production, install certbot before for SSL

2. Modifier les paramètres

Modifiez le fichier env_var.sh pour l'installation en production. Activez nginx si vous avez besoin d'un proxy avec EL_INSTALL_NGINX à True. Redirigez votre DNS vers l'adresse IP du proxy et ajoutez vos enregistrements A et AAAA dans EL_WEBSITE_NAME séparés par des espaces.

3. Exécuter les scripts :

Avec le proxy nginx en production, installer certbot avant pour le SSL

# Snap installation
# https://snapcraft.io/docs/installing-snap-on-debian
sudo apt install -y snapd
sudo snap install core
sudo snap refresh core

# https://certbot.eff.org/lets-encrypt/debianbuster-nginx
# Certbot
sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/bin/certbot

Ubuntu 18.04 server

Serveur Ubuntu 18.04

./script/install/install_dev.sh
./script/install/install_production.sh

A service is running by SystemD. You can access it with the DNS name found in env_var.sh

Ubuntu 20.04 server

Apply fix libpng12-0: https://www.linuxuprising.com/2018/05/fix-libpng12-0-missing-in-ubuntu-1804.html

Un service est en cours d'exécution via SystemD. Vous pouvez y accéder avec le nom DNS trouvé dans env_var.sh

Serveur Ubuntu 20.04

Appliquer le correctif libpng12-0 : https://www.linuxuprising.com/2018/05/fix-libpng12-0-missing-in-ubuntu-1804.html

./script/install/install_dev.sh
./script/install/install_production.sh

A service is running by SystemD, you can access it with the DNS name found in env_var.sh

4. SSL:

Generate a ssl certificate

Un service est en cours d'exécution via SystemD, vous pouvez y accéder avec le nom DNS trouvé dans env_var.sh

4. SSL :

Générer un certificat SSL

sudo certbot --nginx

Watch log

Consulter les journaux

sudo systemctl -feu [EL_USER]

Run by address ip

Comment the following line in /[EL_USER]/erplibre/config.conf

Exécuter par adresse IP

Commentez la ligne suivante dans /[EL_USER]/erplibre/config.conf

xmlrpc_interface = 0.0.0.0
proxy_mode = True

Add your address ip server_name in nginx config /etc/nginx/sites-available/[EL_WEBSITE_NAME]

Restart daemon:

Ajoutez votre adresse IP comme server_name dans la configuration nginx /etc/nginx/sites-available/[EL_WEBSITE_NAME]

Redémarrer le daemon :

sudo systemctl restart nginx
sudo systemctl restart [EL_USER]

Production execution

Exécution en production

cd /[EL_USER]/erplibre
./run.sh -d [DATABASE] --no-database-list

Move prod database to dev

When moving prod database to your dev environment, you want to remove email servers and install user test to test the database. WARNING, this is not safe for production, you will expose all data.

  1. Copy your database image to directory image_db, exemple the image name is my_db.zip
  2. Run

Déplacer la base de données de production vers le développement

Lorsque vous déplacez une base de données de production vers votre environnement de développement, vous souhaitez supprimer les serveurs de messagerie et installer un utilisateur de test pour tester la base de données. ATTENTION, ceci n'est pas sécuritaire pour la production, vous exposerez toutes les données.

  1. Copiez votre image de base de données dans le répertoire image_db, par exemple le nom de l'image est my_db.zip
  2. Exécutez
./script/database/db_restore.py --clean_cache --database test_my_db --image my_db
./script/addons/update_prod_to_dev.sh test_my_db

Update production

Update all features.

Mise à jour de la production

Mettre à jour toutes les fonctionnalités.

./run.sh --limit-time-real 99999 --no-http --stop-after-init -u all -d DATABASE

Postgresql

To show config files:

psql -U postgres -c 'SHOW config_file'

Edit this file to accept interface from all networks:

/var/lib/postgres/data/postgresql.conf

Delete an instance in production

CAUTION, this will delete user's home, it's irrevocable.

Postgresql

Pour afficher les fichiers de configuration :

psql -U postgres -c 'SHOW config_file'

Éditez ce fichier pour accepter les interfaces de tous les réseaux :

/var/lib/postgres/data/postgresql.conf

Supprimer une instance en production

ATTENTION, ceci supprimera le répertoire personnel de l'utilisateur, c'est irrévocable.

./script/database/delete_production.sh

Update ip when public ip change with CloudFlare and crontab

First you need a valid python3 interpreter running with cloudflare module installed: (make sure your pip3 pointing the right python3)

Mettre à jour l'IP lorsque l'IP publique change avec CloudFlare et crontab

Vous avez d'abord besoin d'un interpréteur python3 valide avec le module cloudflare installé : (assurez-vous que votre pip3 pointe vers le bon python3)

pip3 install cloudflare==2.20.0

Then you need to create the cfg files with credentials for your cloudflare account.

Ensuite, vous devez créer les fichiers cfg avec les identifiants de votre compte cloudflare.

mkdir ~/.cloudflare

Edit ~/.cloudflare/cloudflare.cfg

Éditez ~/.cloudflare/cloudflare.cfg

[PROFILE_NAME]
email=EMAIL
token=TOKEN (Use the global API key so that it works)

Add your cron and specify the python3 you want to use with it.

  • USER is the local user with permissions to execute the script
  • PATH is path to inside of ERPLibre/deployment/ folder
  • PROFILE_NAME must match the PROFILE_NAME in cloudflare.cfg
  • CLOUDFLARE_ZONE_NAME is the name of the website zone on cloudflare
  • DNS_NAME is the name of one DNS A record name available on that zone

Notes:

  • Only one crontab is required because the script will automatically research all available zones with outdated ip and update them on all A records.
  • For each crontab run, if public IP did not change compared to what is on cloudflare, the script will not do unnecessary changes and let everything as is.

Ajoutez votre cron et spécifiez le python3 que vous souhaitez utiliser.

  • USER est l'utilisateur local avec les permissions pour exécuter le script
  • PATH est le chemin vers l'intérieur du dossier ERPLibre/deployment/
  • PROFILE_NAME doit correspondre au PROFILE_NAME dans cloudflare.cfg
  • CLOUDFLARE_ZONE_NAME est le nom de la zone du site web sur cloudflare
  • DNS_NAME est le nom d'un enregistrement DNS A disponible sur cette zone

Notes :

  • Un seul crontab est nécessaire car le script recherchera automatiquement toutes les zones disponibles avec une IP obsolète et les mettra à jour sur tous les enregistrements A.
  • À chaque exécution du crontab, si l'IP publique n'a pas changé par rapport à ce qui est sur cloudflare, le script ne fera pas de changements inutiles et laissera tout en l'état.
vim /etc/crontab
# Add
*/5 * * * * USER cd PATH && python3 script/deployment/update_dns_cloudflare.py --profile PROFILE_NAME --zone_name CLOUDFLARE_ZONE_NAME --dns_name DNS_NAME --auto_sync

Check log with

Vérifier les journaux avec

sudo journalctl -feu cron

If you want to log what is happening and when the script is run, like logging when ip changes, you can add a logging part to your cron

Si vous souhaitez journaliser ce qui se passe et quand le script est exécuté, comme la journalisation des changements d'IP, vous pouvez ajouter une partie de journalisation à votre cron

vim /etc/crontab
# Add
*/5 * * * * USER cd PATH && python3 script/deployment/update_dns_cloudflare.py --profile PROFILE_NAME --zone_name CLOUDFLARE_ZONE_NAME --dns_name DNS_NAME --auto_sync > /home/USER/logs/update_dns_ZONE_NAME.log 2>&1

You can then read all logs with this command (Need to have ts installed: sudo apt install moreutils)

Vous pouvez ensuite lire tous les journaux avec cette commande (Nécessite l'installation de ts : sudo apt install moreutils)

tail -f /home/USER/logs/update_dns_ZONE_NAME.log | ts

Docker

Update

When update a docker, you need to update the list of module.

Run script to update configuration :

Docker

Mise à jour

Lors de la mise à jour d'un docker, vous devez mettre à jour la liste des modules.

Exécutez le script pour mettre à jour la configuration :

./script/docker/docker_gen_config.sh

Edit the docker-compose.yml and update the command line (change DATABASE) to :

Éditez le docker-compose.yml et mettez à jour la ligne de commande (changez DATABASE) pour :

    command: odoo --workers 2 -u erplibre_info -d DATABASE

Note, the goal is to call env['ir.module.module'].update_list().

Restart the docker :

Note, l'objectif est d'appeler env['ir.module.module'].update_list().

Redémarrez le docker :

docker compose down
docker compose up -d

Revert the command in docker-compose.yml.

You can validate in log the update, you need to find odoo.modules.loading: updating modules list, check

Annulez la commande dans docker-compose.yml.

Vous pouvez valider la mise à jour dans les journaux, vous devez trouver odoo.modules.loading: updating modules list, vérifiez

docker compose logs -f

Update all

Do a backup on url https://HOST/web/database/manager

Edit the docker-compose.yml and update the command line (change DATABASE) to :

Tout mettre à jour

Faites une sauvegarde à l'URL https://HOST/web/database/manager

Éditez le docker-compose.yml et mettez à jour la ligne de commande (changez DATABASE) pour :

    command: odoo --workers 2 -u all -d DATABASE

Watch log to see error, if you got error, you need to do some code to migrate your data, depend the case.

Surveillez les journaux pour voir les erreurs, si vous obtenez une erreur, vous devez écrire du code pour migrer vos données, selon le cas.

make docker_show_logs_live