First run

Create the account

1. Find the setup token in the server log:

   journalctl -u kogut | grep setup_token

   For Docker, use docker logs kogut. The token is also a file in the data directory: /var/lib/kogut/setup-token with the install script, or /data/setup-token in Docker.

2. In Create the admin account, enter the token, your email, and a password of at least 12 characters.

The token stays valid across restarts until the first account exists. Then kogut removes the file and refuses the token.

Complete the welcome screen

1. Connect a server.

   Enter a name, such as vps-1, and press Create install command. Run the command as root on that server. The host token is shown only once.

   Open the host when it appears and press Monitor beside a discovered service to add its check. See Discovery.

2. Add a site or skip it.

   For a public site, choose Yes, add my site and enter its URL. kogut creates a check and shows the tracking snippet. Otherwise, choose No public site; you can add one later under Settings → Sites.

3. Open the overview.

   The overview shows open incidents, services, and hosts. Use Add check to monitor a service.

You can skip the welcome screen and return to it from the overview.

Add notifications and other checks

1. Under Settings → Notifications, add a channel and press Send test.
2. For a cron job or backup, press Add check and choose Heartbeat. Use its Ping URL button to create a URL for the job. A new URL replaces the old one. See Heartbeats.
3. Add service dependencies in kogut.toml so kogut can relate failures. Objects from the file are read-only in the panel.
4. Connect deploy markers for deploy context in incidents.
5. Set up an external watcher for when kogut itself is down.

Add other people

Under Settings → People, add admins or viewers. For sign-in through an identity provider or a proxy, see OpenID Connect or forward auth.