Documentation
Installer, configurer et utiliser Statup.
Premiers pas
- IntroductionCe qu’est Statup, et les trois éléments qui le composent : les services, les événements et les personnes.
- InstallationLancer Statup avec Docker Compose sur un serveur x86-64 ou ARM, puis créer le premier administrateur.
- Installer sur LinuxInstaller Statup comme service systemd sur un serveur Linux sans Docker, avec une seule commande qui le met aussi à jour et le désinstalle.
- Installer sur Windows ServerInstaller Statup comme service Windows sur Windows Server sans Docker, avec un seul script qui le met aussi à jour et le désinstalle.
- NixOSLancer Statup comme service NixOS depuis le flake de son dépôt.
- Derrière un reverse proxyServir Statup en HTTPS sous un nom à vous, avec nginx, Caddy, IIS ou tout proxy qui pose les en-têtes habituels.
Utilisation
- La page d’étatCe que lisent les collègues et les visiteurs : le bandeau, les services, l’activité récente, les événements et le flux.
- ServicesLes outils dont on dépend, qui les voit, leurs dossiers, leur état, comment il change de lui-même, et l’historique de leur disponibilité.
- IncidentsDéclarer ce qui est en panne, tenir tout le monde informé par des mises à jour, résoudre, puis écrire le bilan.
- MaintenancesAnnoncer des travaux à l’avance, laisser la maintenance commencer et finir d’elle-même, ou la lancer tout de suite.
- AnnoncesInformer de ce qui est nouveau ou de ce qu’il faut savoir, sans toucher à l’état d’aucun service.
Administration
- Équipe et rôlesLecteurs, éditeurs et administrateurs, comment leurs comptes sont créés, les groupes auxquels ils appartiennent, et qui peut voir la page.
- ParamètresLe nom, le logo, les couleurs, le fuseau horaire et le public de la page, la version, et l’organisation du tableau de bord.
- AlertesPublier chaque incident, maintenance et annonce dans Teams, Slack, Google Chat, Discord, Mattermost, ntfy, par e-mail ou dans tout autre outil.
- Widget d’étatUn petit bloc à coller dans un intranet ou un wiki, qui reprend le bandeau de la page d’état et se rafraîchit seul.
- SurveillanceLaisser Statup vérifier qu’un site web ou un serveur répond, et afficher de lui-même une panne quand il ne répond plus.
- Outils de supervisionLaisser Zabbix, Prometheus, Grafana, Uptime Kuma ou un script prévenir Statup qu’un service tombe ou revient.
- JournalCe qui s’est passé sur l’instance, jour par jour, conservé pour les administrateurs et exportable en fichier CSV.
Exploitation
- SauvegardesComment Statup se sauvegarde, comment télécharger une sauvegarde, et comment remettre une instance en route sur le même serveur ou sur un autre.
- Montée de versionPasser à une version plus récente de Statup, ou rester sur une version jusqu’à ce que vous décidiez d’en changer.
- Mot de passe oubliéComment un membre retrouve l’accès, par e-mail ou par un administrateur, et comment réinitialiser n’importe quel compte depuis le serveur.
Référence
- ConfigurationChaque réglage que Statup lit au démarrage, sa valeur par défaut et les valeurs qu’il accepte.
- APILire et modifier les services et les événements depuis un script ou un outil, avec une clé d’API.
- Corps du webhookLe JSON que reçoit un canal webhook pour chaque incident, maintenance, annonce et panne détectée.
- Ligne de commandeLes commandes que le binaire Statup exécute sur le serveur, à côté de l’application web.
- Contrôle de santéL’adresse qu’un répartiteur de charge, un outil de supervision ou Docker peut appeler pour savoir si Statup répond.