Référence du programme d'installation
Le programme d'installation, install.sh, installe, met à niveau, réinstalle et désinstalle Excubius sur un serveur. Il s'exécute en tant que root depuis le package d'installation décompressé. Cette référence répertorie ses options, ses vérifications préalables, les questions qu'il pose et ce qu'il laisse sur le serveur. Pour les étapes d'une installation, consultez Installer Excubius.
sudo ./install.sh [options]
Options
| Option | Effet |
|---|---|
| (aucune) | Installe. Sur un serveur où Excubius est installé, propose Upgrade (la valeur par défaut : conserve les données et les paramètres, et pose uniquement les questions nouvelles dans cette version), Reinstall, Purge ou Cancel |
--check-only | Exécute uniquement les vérifications préalables. Ne modifie rien |
--images FILE | Installe à partir d'une archive d'images, sans accès au registre. Une archive placée dans images/ à côté du script, comme dans le package hors connexion, est utilisée automatiquement |
--answers FILE | Mode non interactif : lignes key=value, secrets compris. Consultez Fichier de réponses |
--reconfigure | Lors d'une mise à niveau, pose de nouveau toutes les questions. Les réponses TLS données à ce moment-là sont appliquées à la plateforme en service |
--reinstall | Supprime le logiciel installé en conservant la base de données, puis installe en posant toutes les questions |
--purge | Supprime tout, base de données comprise, puis effectue une nouvelle installation |
--uninstall | Supprime le logiciel. Écrit d'abord une dernière sauvegarde de la base de données dans <dir>/backups/, puis supprime les unités utilisateur, les conteneurs, les images, <dir>/releases, <dir>/current, /etc/excubius et le paramètre des ports sans privilèges root. Conserve les volumes de la base de données et des certificats, <dir>/backups, <dir>/.env et le compte de service, afin qu'une installation ultérieure retrouve les données |
--uninstall --purge | Supprime aussi tous les volumes, le répertoire d'installation entier avec ses sauvegardes, le compte de service créé par le programme d'installation avec son stockage de conteneurs, et les services de pare-feu ajoutés par l'installation. Vous demande de taper purge |
--no-backup | Aucune sauvegarde finale de la base de données lors de --uninstall ou de --reinstall |
--yes, -y | Accepte toutes les valeurs par défaut existantes ; les réponses obligatoires doivent toujours provenir de --answers ou du clavier. Équivaut à Upgrade sur un serveur déjà installé et confirme une purge |
--dry-run | Affiche ce qui serait fait sans rien modifier. Une installation écrit tout de même ses fichiers de configuration pour que vous les examiniez ; à côté d'un .env existant, sous le nom .env.dry-run |
--skip-checks | Continue même lorsque des vérifications préalables échouent, sur des systèmes non pris en charge, à vos propres risques |
--help, -h | Affiche les options |
Ces combinaisons sont refusées : --uninstall avec --reinstall ou --reconfigure ; --purge avec --reinstall ; --check-only avec --uninstall, --purge ou --reinstall ; --reconfigure avec --purge ou --reinstall.
Seul le répertoire d'installation enregistré est supprimé, jamais un chemin système ni un répertoire personnel.
Vérifications préalables
| Vérification | Exigence | Lorsqu'elle n'est pas satisfaite |
|---|---|---|
| Système d'exploitation | Rocky Linux ou un autre système de la famille RHEL | Échec |
| Version majeure | 9 ou 10 | Avertissement |
| Architecture | x86-64 | Échec |
| Système d'initialisation | systemd | Échec |
| Gestionnaire de packages | dnf | Échec |
| Mémoire | 4 Gio | Avertissement |
| Processeurs | 2 processeurs virtuels | Avertissement |
| Disque | 20 Gio libres sous /home, où le compte de service conserve les images et la base de données | Avertissement |
| Ports | 80 et 443 libres, sur une nouvelle installation | Échec |
| SELinux | Signalé | — |
| Registres | ghcr.io et docker.io joignables en HTTPS, ou une archive d'images lisible | Échec |
| Horloge | Synchronisée | Avertissement ; chrony est activé |
Questions
Appuyez sur Entrée pour accepter la valeur entre crochets. Lors d'une mise à niveau, seules les questions introduites après la version qui a écrit vos réponses sont posées ; la colonne Depuis indique la version qui a introduit chacune d'elles.
| Clé | Question | Valeur par défaut | Posée lorsque | Depuis |
|---|---|---|---|---|
install_dir | Répertoire d'installation | /opt/excubius | Toujours ; un chemin absolu | 0.2.0 |
service_user | Compte de service qui exécute la plateforme | excubius | Toujours ; créé s'il n'existe pas, exécute les conteneurs sans privilèges root | 0.2.0 |
public_url | URL publique que les utilisateurs ouvriront | https://monitoring.example.com | Toujours ; son hôte est le nom principal du serveur | 0.2.0 |
server_aliases | Autres noms de ce serveur | aucun | Toujours ; séparés par des espaces, Entrée pour aucun | 0.3.0 |
tls_mode | Mode de fourniture de HTTPS | letsencrypt | Toujours : letsencrypt, letsencrypt-dns, selfsigned, custom, gateway ou later | 0.2.0 |
tls_cert_names | Noms à inclure dans le certificat | all | Il existe des alias et le mode produit un certificat | 0.3.0 |
tls_email | Adresse e-mail du compte Let's Encrypt | — | letsencrypt ou letsencrypt-dns | 0.2.0 |
tls_dns_provider | Fournisseur DNS de la zone des noms | — | letsencrypt-dns ; un ID dnsapi d'acme.sh comme dns_cf, dns_dreamhost ou dns_azure | 0.3.0 |
tls_dns_credentials | Informations d'identification de l'API DNS | — | letsencrypt-dns ; saisies une par une sans écho | 0.3.0 |
tls_cert_file | Fichier de la chaîne de certificats | — | custom ; PEM, certificat du serveur en premier | 0.3.0 |
tls_key_file | Fichier de la clé privée | — | custom ; PEM, sans phrase secrète, correspondant au certificat | 0.3.0 |
default_preset | Préréglage de base | enterprise | Toujours : enterprise, databases ou core | 0.2.0 |
registry_user, registry_token | Utilisateur du registre et jeton en lecture seule pour les images | — | Sans archive d'images | 0.2.0 |
slack_bot_token | Jeton du bot Slack | — | Toujours ; facultatif | 0.2.0 |
slack_default_channel | Canal Slack pour les alertes | #alerts | Toujours | 0.2.0 |
entra_tenant_id | ID du locataire Entra ID pour la connexion | — | Toujours ; facultatif | 0.2.0 |
entra_client_id, entra_client_secret | ID d'application et secret client Entra ID | — | Un ID de locataire a été fourni | 0.2.0 |
Les modes TLS :
| Mode | Utilisez-le lorsque |
|---|---|
letsencrypt | Chaque nom figure dans le DNS public et pointe vers le serveur, et le port 80 est joignable depuis Internet |
letsencrypt-dns | Vous disposez d'informations d'identification d'API pour la zone DNS des noms. Le serveur n'a pas besoin d'être joignable depuis Internet |
selfsigned | Partout. Les navigateurs affichent un avertissement tant que les utilisateurs n'approuvent pas le certificat |
custom | Votre organisation émet le certificat |
gateway | TLS se termine sur un équilibreur de charge ou un proxy inverse placé en amont |
later | HTTP simple pour l'instant |
Avec un mode Let's Encrypt, le programme d'installation vérifie les noms dans le DNS public et, via HTTP, qu'ils pointent vers ce serveur. Il explique les solutions de rechange dans le cas contraire, et ne s'arrête jamais pour cette raison. Les réponses TLS ne font qu'initialiser les paramètres de la plateforme ; ensuite, elles se gèrent dans Settings › Server.
Valeurs générées
Le programme d'installation génère ces valeurs une seule fois et ne les écrase jamais : le mot de passe de la base de données (POSTGRES_PASSWORD), le secret de signature des sessions (JWT_SECRET), la clé qui chiffre les secrets stockés (EXCUBIUS_DATA_KEY) et le jeton du collecteur (EXCUBIUS_COLLECTOR_TOKEN). Consultez Variables d'environnement.
Fichier de réponses
Pour une installation sans assistance, transmettez --answers FILE avec une ligne key=value par question. Ce fichier contient les secrets ; protégez-le et supprimez-le ensuite. Les informations d'identification DNS tiennent sur une ligne, séparées par ;. Une réponse absente prend la valeur par défaut ; une réponse obligatoire absente ou non valide arrête le programme d'installation en indiquant le nom de la clé, pour que vous puissiez compléter le fichier et relancer l'installation.
Un extrait :
install_dir=/opt/excubius
service_user=excubius
public_url=https://monitoring.areito.example
server_aliases=
tls_mode=letsencrypt-dns
tls_email=ops@areito.example
tls_dns_provider=dns_cf
tls_dns_credentials=CF_Token=<token>
default_preset=enterprise
registry_user=<registry user>
registry_token=<read-only token>
slack_bot_token=<bot token>
slack_default_channel=#areito-alerts
sudo ./install.sh --answers ./answers.conf --yes
Mises à niveau et réponses versionnées
Le programme d'installation enregistre vos réponses non secrètes dans <dir>/install.answers, avec la version du programme d'installation qui les a écrites et l'indication que cette exécution s'est terminée ou non. Lors d'une mise à niveau, il pose uniquement les questions introduites depuis cette version. Une exécution qui ne s'est pas terminée est traitée comme une nouvelle installation : toutes les questions sont posées de nouveau, avec les réponses précédentes comme valeurs par défaut. Les secrets ne sont jamais écrits dans install.answers.
Sur le serveur
| Chemin | Contenu |
|---|---|
<dir>/.env | Configuration et secrets ; mode 0600, appartient au compte de service |
<dir>/install.answers | Vos réponses non secrètes, la version qui les a écrites et l'indication que cette exécution s'est terminée ou non |
<dir>/current | La version installée, un lien vers <dir>/releases/ |
<dir>/backups | Sauvegardes quotidiennes de la base de données, les 14 dernières conservées, ainsi que la sauvegarde finale d'une désinstallation |
~<service account>/.config/systemd/user/ | excubius.service et le minuteur de sauvegarde |
/var/log/excubius-install.log | Le journal du programme d'installation, sans secrets |
Avec le compte de service :
sudo -iu excubius
export XDG_RUNTIME_DIR=/run/user/$(id -u) # once per shell, for systemctl --user
systemctl --user status excubius # the platform
<dir>/current/scripts/compose.sh ps # the containers
<dir>/current/scripts/compose.sh logs -f backend # the API's log
<dir>/current/scripts/backup-db.sh # a database backup now
<dir>/current/scripts/enable-tls.sh --status # TLS without the console
<dir>/current/scripts/rollback.sh # back to the previous release