Installer Cyca avec Docker

Ce document vous guidera dans l’installation de Cyca avec Docker.

Résumé

git clone https://github.com/RichardDern/cyca_docker_compose cyca
cd cyca
cp .env.example .env

Changer les paramètres au besoin, en particulier concernant la base de données et les emails.

docker-compose up -d

Pas-à-pas détaillé

Installer Docker et docker-compose

Si vous n’avez pas encore installé docker et docker-compose, c’est le moment de le faire !

Optionnel: installer git

git n’est pas requis pour installer Cyca. Toutefois, et malgré faible fréquence de mise à jour du dépôt, cela vous assurera de toujours disposer des fichiers les plus à jour pour installer Cyca.

Télécharger les fichiers d’installation de Cyca

Une série de fichiers est fournie pour vous aider à lancer Cyca rapidement. Vous pouvez télécharger directement l’archive, ou utiliser git pour cloner le dépôt.

git clone https://github.com/RichardDern/cyca_docker_compose
cd cyca_docker_compose

Vous pouvez cloner le dépôt dans un répertoire plus “approprié” si vous le souhaitez:

git clone https://github.com/RichardDern/cyca_docker_compose cyca
cd cyca

Créer un fichier de configuration

Copiez le fichier .env.example vers .env:

cp .env.example .env

Modifiez ce fichier selon vos besoins. Chaque option est documentée, certaines nécessite d’être changées, d’autres peuvent l’être, d’autres encore ne devraient pas avoir besoin d’être modifiées.

Définissez l’URL de Cyca et ajustez les paramètres des emails. APP_KEY sera définie automatiquement.

Si vous changez les paramètres de base de données, souvenez-vous de modifier également le fichier docker-compose.yaml fourni pour refléter ces changements. C’est particulièrement important dans le cas où vous modifiez le mot de passe de la base de données.

Lancer Cyca et vérifier que tout fonctionne correctement

Vous pouvez maintenant lancer Cyca avec la commande suivante:

docker-compose up

Si tout tourne correctement, vous devriez voir une série de lignes de journaux. Les deux lignes suivantes sont probablement les plus importantes:

[...]
app_1         | [09-Oct-2020 20:16:33] NOTICE: fpm is running, pid 1
[...]
app_1         | [09-Oct-2020 20:16:33] NOTICE: ready to handle connections

Si vous voyez ceci, et à supposer que vous utilisez les valeurs par défaut, vous devriez pouvoir accéder à Cyca par l’adresse suivante:

http://<ip_or_hostname>

Où vous remplacez <ip_or_hostname> par l’adresse IP ou le nom d’hôte du serveur hébergeant Cyca.

Vous devriez voir la page de connexion de Cyca. Si ce n’est pas le cas, vous devez consulter la sortie de docker, voire les journaux de Cyca, pour déterminer le problème.

Pour consulter les journaux de Cyca, vous pouvez lancer la commande suivante pendant l’exécution du conteneur:

docker exec cyca_app_1 ls /app/storage/logs

Il devrait y avoir au moins un fichier, nommé laravel-(current date).log. Pour consulter ce fichier, lancez:

docker exec cyca_app_1 cat /app/storage/logs/laravel-(current date).log

Ces commandes supposent que cyca_app_1 est le nom de votre conteneur.

Activer l’accès externe à Cyca

Vous aurez remarqué que Cyca lance un service nommé proxy, qui est un serveur nginx, utilisant la configuration du fichier nginx.conf fourni. Ce service expose le port 80 afin que votre instance soit directement accessible par le bon port, mais vous pourriez vouloir le changer s’il est déjà occupé par une autre application sur votre serveur.

Ce service prend également en charge un autre aspect très important de Cyca: les websockets, qui fournissent des notifications en temps réel. Pour cette raison, il est vivement recommandé d’utiliser la configuration fournie et utiliser un reverse-proxy additionnel afin de s’assurer que les websockets fonctionnent correctement, et ajouter une connectivité HTTPS.

Toutefois, vous êtes libre de ne pas utiliser le reverse-proxy de Cyca. Vous pouvez le désactiver en commentant toutes les lignes relatives au service proxy du fichier docker-compose.yaml.

Si vous le faites, vous devrez configurer vous-même l’accès aux serveurs php-fpm et websockets depuis la configuration de votre propre reverse-proxy.

Enfin, vous pouvez également conserver la configuration du proxy de Cyca et ajouter vous-même vos propres directives et certificats au fichier nginx.conf.

Lancer Cyca pour de bon

Nous venons de lancer le conteneur de Cyca au premier plan, ce qui est pratique pour tester l’installation mais pas pour une utilisation quotidienne. Vous pouvez stopper le conteneur en appuyant sur Ctrl+C, puis lancer le conteneur en arrière-plan:

docker-compose up -d

Vous pouvez désormais ouvrir Cyca dans votre navigateur et enregistrer votre premier utilisateur !