Documentation
How to install, configure and use Statup.
Get started
- IntroductionWhat Statup is, and the three things it is made of: services, events and people.
- InstallRun Statup with Docker Compose on an x86-64 or ARM server, then create the first administrator.
- Install on LinuxInstall Statup as a systemd service on a Linux server without Docker, with one command that also upgrades and removes it.
- Install on Windows ServerInstall Statup as a Windows service on Windows Server without Docker, with one script that also upgrades and removes it.
- NixOSRun Statup as a NixOS service from the flake in its repository.
- Behind a reverse proxyServe Statup over HTTPS under a name of your own, with nginx, Caddy, IIS or any proxy that sets the usual headers.
Use
- The status pageWhat colleagues and visitors read: the banner, the services, the recent activity, the events and the feed.
- ServicesThe tools people rely on, who sees them, their folders, their state, how it changes on its own, and their availability history.
- IncidentsDeclare what is broken, keep people posted with updates, resolve it, and write the report.
- MaintenanceAnnounce planned work ahead, let it start and end on its own, or start it right away.
- AnnouncementsTell people what is new or what they should know, without touching the state of any service.
Administer
- Team and rolesReaders, editors and administrators, how their accounts are made, the groups they belong to, and who can see the page.
- SettingsThe page’s name, logo, colours, time zone and audience, the version, and the layout of the dashboard.
- AlertsPost each incident, maintenance and announcement to Teams, Slack, Google Chat, Discord, Mattermost, ntfy, email or any other tool.
- Status widgetA small box to paste into an intranet or a wiki, which repeats the banner of the status page and refreshes itself.
- MonitoringLet Statup check that a website or a server answers, and show an outage on its own when it stops.
- Monitoring toolsLet Zabbix, Prometheus, Grafana, Uptime Kuma or a script tell Statup that a service is down or back up.
- JournalWhat happened on the instance, day by day, kept for administrators and exported as a CSV file.
Operate
- BackupsHow Statup backs itself up, how to download a backup, and how to bring an instance back on the same server or on another.
- UpgradingMove to a newer version of Statup, or stay on one until you choose.
- Forgotten passwordHow a member gets back in, by email or through an administrator, and how the host resets any account.
Reference
- ConfigurationEvery setting Statup reads at start, its default and the values it takes.
- APIRead and change services and events from a script or a tool, with an API key.
- Webhook bodyThe JSON that a webhook channel receives for each incident, maintenance, announcement and detected outage.
- Command lineThe commands the Statup binary runs on the server, next to the web app.
- Health checkThe address a load balancer, a monitoring tool or Docker can call to know that Statup answers.