Docker Compose

Exécutez une instance Status200 complète et gratuite sur un seul serveur Linux avec Docker Compose. Cette page vous mène d'un serveur vierge à une instance en fonctionnement, puis couvre HTTPS, le durcissement pour la production, les sauvegardes, les mises à jour et la désinstallation. Pour travailler plutôt sur le code de Status200 lui-même, voir Développement local.

Fonctionnement#

Docker Compose exécute chaque partie de Status200 sous forme de conteneur sur votre serveur. Tout le trafic entre par le conteneur ingress, qui l'achemine vers l'app. L'application conserve ses données dans PostgreSQL, ClickHouse et Valkey. Une sonde intégrée exécute les vérifications de vos moniteurs et renvoie les résultats via l'ingress.

Pour la production à grande échelle, ou quand vous avez besoin de haute disponibilité, utilisez plutôt le chart Helm sur Kubernetes : Docker Compose exécute une seule copie de chaque service sur un seul serveur.

Prérequis#

Choisissez la taille du serveur selon ce que vous allez y exécuter. C'est la télémétrie (logs, métriques, traces) qui détermine la mémoire et le disque ; consultez Dimensionnement et planification de la capacité une fois vos volumes connus.

Le minimum pour un homelab convient à un usage personnel et expérimental — certains font tourner Status200 sur un Raspberry Pi.

Il vous faut aussi :

• Docker avec le plugin Docker Compose v2 (la commande docker compose).
• Git, pour récupérer Status200.
• Node.js et npm, qui exécutent les scripts npm start et npm run update qui enveloppent Docker Compose.
• Ports 80 et 443 libres sur le serveur. Le tableau ci-dessous liste chaque port que Status200 utilise sur l'hôte.

Il existe aussi une vidéo pas à pas de l'installation.

Installer Status200#

1. Cloner la branche release#

   La branche release contient les fichiers de la dernière version.

   Bash

   git clone --depth 1 --single-branch --branch release https://git.wilix.dev/status200/status200.git
   cd oneuptime

2. Créer config.env#

   Tous les paramètres de Status200 se trouvent dans config.env. Partez de l'exemple :

   Bash

   cp config.example.env config.env

3. Définir le nom d'hôte#

   Ouvrez config.env et réglez HOST sur le nom de domaine ou l'adresse IP qu'on utilisera pour joindre Status200, sans http://. Ne gardez localhost que pour essayer Status200 sur votre propre ordinateur.

   config.envINI

   HOST=status200.example.com

4. Générer des secrets aléatoires#

   Le fichier d'exemple contient des secrets factices qui sont publics sur GitHub. Remplacez chacun par sa propre valeur aléatoire :

   Bash

   while grep -q "please-change-this-to-random-value" config.env; do
     sed -i "0,/please-change-this-to-random-value/{s/please-change-this-to-random-value/$(openssl rand -hex 32)/}" config.env
   done
   grep -c "please-change-this" config.env

   La dernière commande affiche 0 : il ne reste aucun secret factice. La boucle utilise GNU sed, présent sur tout serveur Linux. Voici les paramètres qu'elle remplit :

   Paramètre	Ce qu'il protège
   ONEUPTIME_SECRET	Les appels entre les services de Status200.
   ENCRYPTION_SECRET	Les secrets que Status200 stocke, comme les jetons d'intégration et les mots de passe SMTP, et les jetons de connexion qu'il émet.
   DATABASE_PASSWORD, CLICKHOUSE_PASSWORD, VALKEY_PASSWORD	Les trois stockages de données.
   REGISTER_PROBE_KEY	L'enregistrement des sondes auprès de votre instance.
   GLOBAL_PROBE_1_KEY, GLOBAL_PROBE_2_KEY	Les sondes globales que Docker Compose peut exécuter (probe-1 tourne par défaut).
   STATUS200_RUNNER_KEY	Le Runner intégré.
   GLOBAL_RUNNER_KEY	Le Runner global intégré, qui exécute les étapes JavaScript de tous les projets.

   Important

   Définissez les secrets avant le premier démarrage, et conservez-les ensuite. PostgreSQL ne prend son mot de passe qu'à la création de sa base, et modifier ENCRYPTION_SECRET plus tard rend illisible toute valeur chiffrée avec l'ancien. Si DATABASE_PASSWORD est encore le secret factice au premier démarrage, npm start lui donne une valeur aléatoire avant que PostgreSQL ne crée sa base.

5. Démarrer Status200#

   npmDocker CLI

   npm

   Bash

   npm start

   Docker CLI

   Bash

   (export $(grep -v '^#' config.env | xargs) && docker compose up --remove-orphans -d)

   Le premier démarrage prend plusieurs minutes : Docker télécharge les images et Status200 crée ses bases de données. npm start attend que chaque partie réponde et se termine par Status200 is up!

6. Créer le premier compte#

   Ouvrez http:// suivi de votre HOST (par exemple http://localhost) et inscrivez-vous. Le premier compte d'une nouvelle instance en devient l'administrateur principal, qui peut ouvrir l'Admin Dashboard à /admin.

   Toute personne qui peut joindre la page peut s'inscrire après vous. Pour l'empêcher, ouvrez l'Admin Dashboard, allez dans Paramètres > Authentification et désactivez Autoriser les inscriptions. Les personnes que vous invitez dans un projet peuvent toujours créer leur compte.

Configurer HTTPS#

Status200 sert du HTTP simple jusqu'à ce que vous choisissiez l'une des deux façons d'ajouter HTTPS :

Si vous placez des pages de statut ou des tableaux de bord sur des domaines personnalisés, laisser Status200 gérer TLS est la configuration la plus simple : l'ingress commande et sert lui-même les certificats de ces domaines.

Avec HTTP_PROTOCOL=https, Status200 construit des liens HTTPS, garde les cookies de connexion sur HTTPS et demande aux navigateurs de n'atteindre votre HOST qu'en HTTPS. Un navigateur s'y tient pendant un an, sur tous les ports de ce nom ; si HOST doit un jour répondre de nouveau en HTTP simple, définissez donc HSTS_MAX_AGE_SECONDS=0 dans config.env quelque temps avant : les navigateurs oublient la règle à leur visite suivante.

Laisser Status200 obtenir un certificat#

1. Faire pointer votre domaine vers le serveur#

   Créez un enregistrement DNS A (ou AAAA pour IPv6) pour votre domaine, avec l'adresse IP publique du serveur comme valeur. Avec un enregistrement AAAA, activez aussi IPv6 pour Status200 : voir Adresses des visiteurs.

2. Activer l'obtention de certificats#

   Définissez ces valeurs dans config.env :

   config.envINI

   HOST=status200.example.com
   PROVISION_SSL=true
   HTTP_PROTOCOL=https

   HOST doit être un nom de domaine : Status200 ne peut pas obtenir de certificat pour une adresse IP ni pour localhost.

3. Redémarrer avec les nouveaux paramètres#

   Bash

   npm start

4. Ouvrir votre instance en HTTPS#

   Ouvrez https://status200.example.com. Status200 commande le certificat au démarrage puis le vérifie toutes les heures, et le renouvelle quand il reste moins de 30 jours. Jusqu'à l'arrivée du premier certificat, généralement en quelques minutes, l'ingress sert un certificat auto-signé temporaire et votre navigateur vous avertit.

Utiliser votre propre reverse proxy#

Ces étapes font tourner le proxy sur le même serveur que Status200. Si votre proxy tourne sur une autre machine, sautez la première étape, pointez le proxy vers le port 80 de ce serveur et, avec le pare-feu de votre fournisseur cloud, ne laissez que le proxy joindre les ports 80 et 443 : un visiteur qui joint Status200 sans passer par le proxy peut choisir l'adresse sous laquelle Status200 le compte.

1. Déplacer l'ingress hors des ports 80 et 443#

   Le proxy a besoin des ports 80 et 443 : déplacez donc l'ingress sur d'autres ports, publiés uniquement sur l'adresse de bouclage 127.0.0.1 de ce serveur, pour que les visiteurs ne joignent Status200 qu'à travers votre proxy. La sonde et le Runner utilisent le réseau de l'hôte et joignent Status200 via http://localhost, ils suivent donc le changement :

   config.envINI

   ONEUPTIME_HTTP_PORT=127.0.0.1:8080
   STATUS_PAGE_HTTPS_PORT=127.0.0.1:8443
   GLOBAL_PROBE_1_STATUS200_URL=http://localhost:8080
   ONEUPTIME_RUNNER_STATUS200_URL=http://localhost:8080

2. Indiquer à Status200 qu'il est derrière un proxy#

   config.envINI

   HOST=status200.example.com
   HTTP_PROTOCOL=https
   PROVISION_SSL=false
   TRUSTED_PROXY_HOPS=2

   HTTP_PROTOCOL=https fait utiliser HTTPS aux liens que Status200 construit. TRUSTED_PROXY_HOPS=2 compte votre proxy et l'ingress de Status200, pour que Status200 lise l'adresse réelle du visiteur pour les listes d'IP autorisées et les limites de débit. Ajoutez-en un pour chaque proxy supplémentaire qui complète X-Forwarded-For, comme un CDN ou un équilibreur de charge.

3. Redémarrer Status200 sur les nouveaux ports#

   Bash

   (export $(grep -v '^#' config.env | xargs) && docker compose up --remove-orphans -d)
   bash Tests/Scripts/status-check.sh localhost:8080

   npm start vérifie http://localhost sur le port 80, là où sera votre proxy : vérifiez donc vous-même le nouveau port. Le script se termine par Status200 is up!

4. Configurer le proxy#

   CaddyNginx

   Caddy

   Caddyfile

   status200.example.com {
       reverse_proxy localhost:8080
   }

   Caddy obtient et renouvelle le certificat lui-même, redirige HTTP vers HTTPS et laisse passer les connexions WebSocket. Rechargez Caddy après avoir modifié le fichier, par exemple avec sudo systemctl reload caddy.

   Nginx

   /etc/nginx/conf.d/status200.confNginx

   map $http_upgrade $status200_connection_upgrade {
       default upgrade;
       ""      close;
   }
   
   server {
       listen 80;
       server_name status200.example.com;
       return 301 https://$host$request_uri;
   }
   
   server {
       listen 443 ssl;
       server_name status200.example.com;
   
       ssl_certificate     /etc/letsencrypt/live/status200.example.com/fullchain.pem;
       ssl_certificate_key /etc/letsencrypt/live/status200.example.com/privkey.pem;
   
       # The limits Status200's own ingress uses.
       client_max_body_size 50M;
       proxy_read_timeout 300s;
       proxy_send_timeout 300s;
   
       proxy_http_version 1.1;
       proxy_set_header Host $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header X-Forwarded-Proto $scheme;
       proxy_set_header Upgrade $http_upgrade;
       proxy_set_header Connection $status200_connection_upgrade;
   
       location / {
           proxy_pass http://127.0.0.1:8080;
       }
   
       # MCP clients keep a stream open.
       location /mcp {
           proxy_pass http://127.0.0.1:8080;
           proxy_buffering off;
           proxy_read_timeout 86400s;
           proxy_send_timeout 86400s;
       }
   }

   Les chemins des certificats sont ceux où Certbot place un certificat Let's Encrypt ; utilisez les chemins de votre propre certificat s'il vient d'ailleurs. Vérifiez le fichier et rechargez Nginx avec sudo nginx -t && sudo systemctl reload nginx.

   Les deux envoient X-Forwarded-Proto, qui indique à Status200 qu'un visiteur est venu en HTTPS. Tout autre proxy doit l'envoyer aussi, sinon les cookies de connexion des pages de statut et des tableaux de bord sur vos domaines personnalisés ne restent pas sur HTTPS.

5. Ouvrir votre instance via le proxy#

   Ouvrez https://status200.example.com. Vous devriez voir la page de connexion de Status200, servie avec le certificat de votre proxy.

Adresses des visiteurs#

Status200 compte chaque visiteur selon l'adresse depuis laquelle il se connecte : les limites de connexion, les autres limites par adresse et les listes d'IP autorisées des pages de statut et des tableaux de bord la lisent toutes. Deux configurations ont besoin d'un réglage pour que cette adresse soit bien celle du visiteur :

Sans IPv6 sur le réseau de Status200, Docker transmet chaque visiteur qui arrive en IPv6 à Status200 depuis une adresse à lui, et Status200 les compte tous comme un seul visiteur : les échecs de connexion d'une personne peuvent bloquer les autres. Activer IPv6 demande Docker Engine 27 ou plus récent (docker version affiche la vôtre).

1. Activer IPv6#

   Créez docker-compose.override.yml à côté de docker-compose.yml, ou complétez celui que vous avez ; npm start et npm run update le lisent :

   docker-compose.override.ymlYAML

   networks:
     oneuptime:
       enable_ipv6: true

2. Redémarrer Status200#

   Bash

   npm stop
   npm start

   Status200 s'arrête, puis redémarre avec IPv6 sur son réseau. Vos données sont conservées. Docker ne peut pas supprimer un réseau auquel un conteneur à vous est encore rattaché, comme un reverse proxy : détachez-le d'abord du réseau de Status200, et rattachez-le ensuite. Si npm start s'arrête sur has active endpoints, détachez-le, puis relancez npm stop et npm start.

3. Vérifier le réseau#

   Bash

   docker network ls --quiet --filter name=_oneuptime | xargs docker network inspect | grep EnableIPv6

   La commande affiche "EnableIPv6": true,.

Quand plusieurs personnes se connectent depuis une même adresse de réseau privé, la page Santé Status200 de l'Admin Dashboard le signale, avec le réglage qui change cela.

Liste de contrôle pour la production#

Docker Compose exécute une seule copie de chaque service sur un seul serveur, ce qui convient aux petites équipes et aux homelabs. Avant de vous y fier, passez cette liste en revue.

Changer le mot de passe de la base#

PostgreSQL garde le mot de passe avec lequel il a été créé : changer seulement DATABASE_PASSWORD dans config.env prive Status200 de sa base. Pour donner un mot de passe propre à une installation qui a démarré avec le secret factice, changez-le dans PostgreSQL et dans config.env en même temps, puis redémarrez Status200 :

NEW_PASSWORD=$(openssl rand -hex 32) &&
  (export $(grep -v '^#' config.env | xargs) && docker compose exec -T postgres psql -U "$DATABASE_USERNAME" -d "$DATABASE_NAME" -c "ALTER USER \"$DATABASE_USERNAME\" PASSWORD '$NEW_PASSWORD'") &&
  sed -i "s/^DATABASE_PASSWORD=.*/DATABASE_PASSWORD=$NEW_PASSWORD/" config.env
npm start

Si vous avez défini DATABASE_BACKUP_PASSWORD et DATABASE_RESTORE_PASSWORD, donnez-leur aussi la nouvelle valeur.

Sauvegarder et restaurer#

PostgreSQL contient tout ce que vous configurez : moniteurs, incidents, pages de statut, utilisateurs. npm run backup le vide dans un fichier du dossier Backups.

1. Donner au script de sauvegarde le mot de passe de la base#

   Dans config.env, réglez DATABASE_BACKUP_PASSWORD sur la valeur de DATABASE_PASSWORD. Le script lit config.env comme du texte brut : le ${DATABASE_PASSWORD} fourni n'est donc jamais remplacé.

2. Lancer la sauvegarde#

   Bash

   npm run backup

   Il demande votre mot de passe sudo et écrit Backups/db-<day of the month>.backup : les sauvegardes quotidiennes remplacent donc celles du mois précédent. Lancez-le au moins une fois par jour.

3. Copier les sauvegardes hors du serveur#

   Une sauvegarde sur le même disque que la base de données ne survit pas à la perte de ce disque.

Seul le serveur lui-même joint PostgreSQL : il répond sur le port 5400 de 127.0.0.1. Pour le sauvegarder depuis une autre machine, ouvrez un tunnel SSH depuis cette machine, puis connectez-vous à son propre port 5400 :

ssh -N -L 5400:127.0.0.1:5400 you@status200.example.com

services:
  postgres:
    ports:
      - "10.0.0.5:5401:5432"

ClickHouse conserve votre télémétrie dans le volume Docker status200_clickhouse, et aucun script ne le sauvegarde. Si vous devez conserver cette télémétrie, sauvegardez le volume avec un outil ClickHouse comme clickhouse-backup, ou copiez-le pendant que Status200 est arrêté.

Pour restaurer PostgreSQL, définissez les valeurs DATABASE_RESTORE_* dans config.env : DATABASE_RESTORE_PASSWORD sur la valeur de DATABASE_PASSWORD, comme pour les sauvegardes, et DATABASE_RESTORE_FILENAME sur la sauvegarde à restaurer, par exemple db-31.backup. Lancez ensuite bash restore.sh. La base dans laquelle il restaure doit déjà exister ; c'est le cas sur une installation en fonctionnement.

Mettre à jour Status200#

Sauvegardez d'abord, puis lancez :

git checkout release
git pull
npm run update

npm run update demande votre mot de passe sudo, ajoute à votre config.env les nouveaux paramètres de config.example.env (vos propres valeurs sont conservées), récupère les nouvelles images et redémarre Status200. Comme npm start, il se termine par Status200 is up!

Passer à une nouvelle version majeure (de 13 à 14, par exemple) peut demander davantage : lisez Mettre à niveau Status200 avant de commencer.

APP_TAG=release dans config.env récupère toujours la dernière version de la Community Edition. Pour rester sur une version, réglez APP_TAG sur son numéro, par exemple 14.0.22. Pour l'Enterprise Edition, les tags sont enterprise-release et enterprise-14.0.22.

Désinstaller Status200#

Arrêtez Status200 et supprimez ses conteneurs et son réseau :

npm run down

Vos données restent dans les volumes status200_postgres et status200_clickhouse, et le dossier oneuptime conserve config.env et vos sauvegardes. Pour supprimer aussi les données :

(export $(grep -v '^#' config.env | xargs) && docker compose down --volumes --remove-orphans)

Supprimez ensuite le dossier oneuptime.

Dépannage#

sudo usermod -aG docker $USER

npm run ps
npm run logs

(export $(grep -v '^#' config.env | xargs) && docker compose logs app) | grep -A 5 CoreSSL

Étapes suivantes#