Ce type d'installation est encore expérimental.
Cette méthode d'installation est actuellement uniquement disponible sur la branche de développement. La branche master (production) sera bientôt disponible également.
Cette page explique comment installer Dokos à l'aide de Docker. Seules les distributions Linux sont prises en charge entièrement par ce guide d'installation, même s'il est possible d'installer Dokos via Docker sur Windows ou macOS. Pour toute demande de support, rendez-vous sur le forum de la communauté Dokos.
Afin d'installer Dokos sur Docker, vous devez installer les composants suivants sur votre serveur :
Concernant git et python3, ces deux composants sont pré-installés sur la plupart des distributions Linux.
Vous pouvez trouver plus d'informations sur l'installation de docker sur le site web de Docker. Un script d'installation simplifié de Docker est proposé dans le répertoire GitHub docker/docker-install, il se résume à :
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
Pour docker-compose, l'installation est détaillée dans la section correspondante sur le site web de Docker.
N'oubliez pas d'ajouter votre utilisateur au groupe docker. D'autres étapes post-installation de Docker sous Linux facultatives sont disponibles:
sudo usermod -aG docker $USER
N'oubliez pas de vous déconnecter puis de vous reconnecter pour que l'adhésion au groupe utilisateur docker soit prise en compte.
Vous pouvez vérifier que ces différents composants sont correctement installés avec les commandes suivantes :
git version
python3 -V
docker -v
docker-compose -v
docker run hello-world
Afin de faciliter l'installation et la maintenance des images Docker, nous avons créé un outil appelé dokidocker. Cet outil se fonde sur le très bon travail fourni par l'équipe de frappe-docker.
Afin de télécharger dokidocker, lancez les commandes suivantes sur votre serveur:
git clone https://gitlab.com/dokos/dokidocker.git
cd dokidocker
Avant de lancer vos images Docker, vous devez définir un certain nombre de paramètres. Ces paramètres sont les variables d'environnement définies dans un fichier .env que vous devez créer.
Vous pouvez créer une configuration rapidement à l'aide de l'outil en ligne de commande intégré à dokidocker. Lancez la commande suivante et remplissez les différentes informations de manière interactive.
./cli.py init
Cette commande s'occupe de créer le fichier de configuration .env et de démarrer les services Docker pour créer votre site.
Si vous souhaitez configurer les détails de votre installation, vous pouvez créer un fichier d'environnement en copiant le modèle fourni et en consultant la référence des variables d'environnement :
cp env-template .env
Modifiez ensuite le fichier nouvellement créé pour personnaliser chaque variable d'environnement. Vous pouvez utiliser n'importe quel éditeur de texte ou un éditeur intégré à la ligne de commande comme par exemple nano .env. Chaque variable est définie selon le modèle nom=valeur, par exemple SITE_NAME=erp.votre-site.com. Les lignes vides ou commençant par un # sont ignorées.
Une fois le fichier .env configuré à votre guise, lancez la commande ./cli.py init pour lancer l'installation du site.
Le téléchargement des images Docker et la configuration du site peuvent prendre quelques minutes ou plus en fonction du débit disponible sur votre serveur. Quelques instants après avoir lancé la commande ./cli.py init, votre site devrait être fonctionnel. Pour accéder à votre site, rendez-vous sur le site que vous avez renseigné dans la variable SITE_NAME.
Si jamais votre site ne semble pas fonctionner, rendez-vous dans la section dépannage de ce document.
Une fois le serveur lancé, vous pouvez accéder au site en utilisant le nom d'utilisateur Administrator et le mot de passe défini dans la variable ADMIN_PASSWORD.
Pour stopper Dokos, sans perdre vos données, vous pouvez utiliser les commandes docker-compose stop ou docker-compose down.
Afin de démarrer Dokos, lancez la commande suivante:
docker-compose up -d
Choisir la nouvelle version à utiliser.
Cette étape est nécessaire si vous utilisez des images qui référencent une version précise. Sélectionnez les nouvelles versions de Dodock et Dokos en modifiant les valeurs de DODOCK_VERSION et DOKOS_VERSION dans le fichier de configuration .env, par exemple en utilisant la commande nano .env.
Télécharger les nouvelles images avec la commande docker-compose pull
Redémarrez les conteneurs
docker-compose up -d
/
Les variables par défaut sont:
DOKOS_VERSION: Définit la version de Dokos à utiliser. latest indique la dernière version de développement. Pour les autres tags disponibles, jetez un oeil au registre.
DODOCK_VERSION: Défini la version de Dodock à utiliser. latest indique la dernière version de développement. Pour les autres tags disponibles, jetez un oeil au registre.
SITE_NAME: Site créé après le lancement des conteneurs. Le nom du site doit être un nom de domaine complet, par exemple erp.example.com.
SITES: Liste des sites inclus dans ce déploiement. Si Let's Encrypt est configuré, assurez-vous que vos paramètres DNS pointent correctement vers le serveur actuel.
ADMIN_PASSWORD: Mot de passe administrateur pour Dodock/Dokos.
INSTALL_APPS: Applications contenues dans l'image utilisée et qui doivent être installées sur le site défini dans SITE_NAME. Dodock est installée par défaut (et ne peut pas être retirée), Dokos s'appelle erpnext et est présente dans la configuration par défaut.
MARIADB_HOST: Nom de domaine pour MariaDB. Gardez mariadb si vous utilisez le conteneur de base de donnée par défaut.
DB_ROOT_USER: Nom d'utilisateur Root pour MariaDB.
MYSQL_ROOT_PASSWORD: Mot de passe pour accéder à la base de données MariaDB dans un conteneur. Si vous utilisez une base de données MariaDB gérée ou externe, vous n'avez pas besoin de définir de mot de passe ici.
./cli.py init peut prendre plusieurs minutes.docker-compose logs pour consulter les informations de lancement et les logs d'accès au serveur (docker-compose logs webserver)..env peut entraîner des problèmes.