Aller au contenu principal
Version : 0.4 · actuelle

Référence du programme d'installation

RéférenceRévisé le 11 octobre 2026
S'applique à :Excubius 0.4Rôles : Installateur (administrateur Linux)
PlansFree · Core · Pro · EnterpriseDéploiementAuto-hébergé

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​

OptionEffet
(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-onlyExécute uniquement les vérifications préalables. Ne modifie rien
--images FILEInstalle à 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 FILEMode non interactif : lignes key=value, secrets compris. Consultez Fichier de réponses
--reconfigureLors 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
--reinstallSupprime le logiciel installé en conservant la base de données, puis installe en posant toutes les questions
--purgeSupprime tout, base de données comprise, puis effectue une nouvelle installation
--uninstallSupprime 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 --purgeSupprime 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-backupAucune sauvegarde finale de la base de données lors de --uninstall ou de --reinstall
--yes, -yAccepte 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-runAffiche 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-checksContinue même lorsque des vérifications préalables échouent, sur des systèmes non pris en charge, à vos propres risques
--help, -hAffiche 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érificationExigenceLorsqu'elle n'est pas satisfaite
Système d'exploitationRocky Linux ou un autre système de la famille RHELÉchec
Version majeure9 ou 10Avertissement
Architecturex86-64Échec
Système d'initialisationsystemdÉchec
Gestionnaire de packagesdnfÉchec
Mémoire4 GioAvertissement
Processeurs2 processeurs virtuelsAvertissement
Disque20 Gio libres sous /home, où le compte de service conserve les images et la base de donnéesAvertissement
Ports80 et 443 libres, sur une nouvelle installationÉchec
SELinuxSignalé—
Registresghcr.io et docker.io joignables en HTTPS, ou une archive d'images lisibleÉchec
HorlogeSynchroniséeAvertissement ; 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éQuestionValeur par défautPosée lorsqueDepuis
install_dirRépertoire d'installation/opt/excubiusToujours ; un chemin absolu0.2.0
service_userCompte de service qui exécute la plateformeexcubiusToujours ; créé s'il n'existe pas, exécute les conteneurs sans privilèges root0.2.0
public_urlURL publique que les utilisateurs ouvrironthttps://monitoring.example.comToujours ; son hôte est le nom principal du serveur0.2.0
server_aliasesAutres noms de ce serveuraucunToujours ; séparés par des espaces, Entrée pour aucun0.3.0
tls_modeMode de fourniture de HTTPSletsencryptToujours : letsencrypt, letsencrypt-dns, selfsigned, custom, gateway ou later0.2.0
tls_cert_namesNoms à inclure dans le certificatallIl existe des alias et le mode produit un certificat0.3.0
tls_emailAdresse e-mail du compte Let's Encrypt—letsencrypt ou letsencrypt-dns0.2.0
tls_dns_providerFournisseur DNS de la zone des noms—letsencrypt-dns ; un ID dnsapi d'acme.sh comme dns_cf, dns_dreamhost ou dns_azure0.3.0
tls_dns_credentialsInformations d'identification de l'API DNS—letsencrypt-dns ; saisies une par une sans écho0.3.0
tls_cert_fileFichier de la chaîne de certificats—custom ; PEM, certificat du serveur en premier0.3.0
tls_key_fileFichier de la clé privée—custom ; PEM, sans phrase secrète, correspondant au certificat0.3.0
default_presetPréréglage de baseenterpriseToujours : enterprise, databases ou core0.2.0
registry_user, registry_tokenUtilisateur du registre et jeton en lecture seule pour les images—Sans archive d'images0.2.0
slack_bot_tokenJeton du bot Slack—Toujours ; facultatif0.2.0
slack_default_channelCanal Slack pour les alertes#alertsToujours0.2.0
entra_tenant_idID du locataire Entra ID pour la connexion—Toujours ; facultatif0.2.0
entra_client_id, entra_client_secretID d'application et secret client Entra ID—Un ID de locataire a été fourni0.2.0

Les modes TLS :

ModeUtilisez-le lorsque
letsencryptChaque nom figure dans le DNS public et pointe vers le serveur, et le port 80 est joignable depuis Internet
letsencrypt-dnsVous disposez d'informations d'identification d'API pour la zone DNS des noms. Le serveur n'a pas besoin d'être joignable depuis Internet
selfsignedPartout. Les navigateurs affichent un avertissement tant que les utilisateurs n'approuvent pas le certificat
customVotre organisation émet le certificat
gatewayTLS se termine sur un équilibreur de charge ou un proxy inverse placé en amont
laterHTTP 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​

CheminContenu
<dir>/.envConfiguration et secrets ; mode 0600, appartient au compte de service
<dir>/install.answersVos 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>/currentLa version installée, un lien vers <dir>/releases/
<dir>/backupsSauvegardes 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.logLe 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