Get started
Install
Run Statup with Docker Compose on an x86-64 or ARM server, then create the first administrator.
Requirements
- Docker with Docker Compose 2.24 or newer.
- A 64-bit server, x86-64 or ARM: the image is published for both.
On NixOS, Statup also runs as a service from its flake: see NixOS.
Start Statup
mkdir statup && cd statup
curl -O https://raw.githubusercontent.com/karl-cta/statup/main/docker-compose.yml
docker compose up -d
Docker downloads the image ghcr.io/karl-cta/statup:latest and starts it. Statup answers on port 3000 of the server.
What docker-compose.yml sets
| Setting | Value |
|---|---|
| Image | ghcr.io/karl-cta/statup:latest, which follows each new version. See Upgrading to stay on one. |
| Port | 3000:3000: the port of the server first, then the port of the container. |
| Volume | statup_data, mounted at /data: the database and the uploaded files. See Backups. |
| Settings | A .env file next to docker-compose.yml, optional. See Configuration. |
| Restart | unless-stopped: Statup starts again with the server. |
| Privileges | None: no-new-privileges, every capability dropped. The container runs as the user statup. |
| Logs | Rotated at 10 MB, three files kept. docker compose logs statup reads them. |
The image checks its own health every 30 seconds.
First launch
Open http://localhost:3000, or your server’s address on port 3000. An empty instance leads through four steps, with a preview of the page beside each one.
- Account: Name, Email address and Password. This first account is the administrator. The instance takes its time zone from your browser.
- Page: Page name (optional, up to 40 characters), Logo (optional), and Page access: Members only or Public.
- Services: “The tools to follow”. Tick some of the most common, or type your own, and open Monitor this service to add a check. Optional, up to 50 at once.
- Ready: the address of the page, with Copy, to share with the people who use your services. Open the dashboard ends the setup.
Everything can be changed later in Settings, and services added from the Services page.
Warning
Until the first account exists, anyone who opens the address can create it and become the administrator. Create yours right after the first start, or preset it as below.
Preset the administrator
Write ADMIN_EMAIL and ADMIN_PASSWORD in .env before the first start. Statup creates the administrator when it starts, named after the part of the address before the @. A value that breaks the password rule stops it at start.
Then sign in at /login. The setup steps are not shown: the dashboard holds a First steps card instead, to add services and share the address. The time zone stays TZ, or UTC, until it is set in Settings. Remove both values from .env once the account exists.
Reach Statup from your network
Your colleagues open the server’s address on port 3000. To use another port, change the part before :3000 under ports: in docker-compose.yml, then run docker compose up -d again.
For HTTPS and a name of your own, such as status.example.com, put Statup behind a reverse proxy.
Next
- Add your colleagues: Team and roles.
- Tell people where they already read: Alerts.
- Let Statup notice an outage first: Monitoring.