Getting started¶

This page takes you from the AWS Marketplace listing to the Gatus status page in your browser. It takes about fifteen minutes.

You need: an AWS account with permission to subscribe to AWS Marketplace products and launch EC2 instances, and, on your workstation, the AWS CLI with the Session Manager plugin.

Open the Gatus Status Page listing, choose View purchase options, review the terms and subscribe.

2. Launch the instance¶

Choose Launch your software and use these settings:

Instance type: t3.medium.
Storage: an encrypted gp3 root volume of at least 16 GiB.
IAM instance profile: a role with the AWS managed policy AmazonSSMManagedInstanceCore, so you can connect with Session Manager.
Security group: no inbound rules are needed. If you want SSH as well, allow port 22 only from your own administrative network.
Metadata: require IMDSv2.

3. Connect and wait for first boot¶

In the EC2 console, select the instance, choose Connect, then Session Manager. Switch to the ubuntu user and wait for first boot:

sudo -iu ubuntu
cloud-init status --wait
systemctl is-active sushi-gatus-firstboot.service gatus.service

Both units should report active.

4. Run the walkthrough¶

bash /opt/sushi/docs/demo.sh

It checks that Gatus is running on loopback, that /health answers, that the statuses API refuses requests without a password and accepts the admin user, and then runs the image's self-test. It ends with SUSHI_CUSTOMER_DEMO_PASSED.

5. Get the admin password¶

sudo cat /var/lib/gatus/admin.password

The user name is admin. Keep the password out of tickets, chat and screen recordings.

6. Open the status page¶

On your workstation, start a port-forwarding session. Replace <instance-id> with your instance ID, and use the instance's region:

aws ssm start-session \
  --target <instance-id> \
  --document-name AWS-StartPortForwardingSession \
  --parameters '{"portNumber":["8443"],"localPortNumber":["8443"]}'

Leave it running and open https://localhost:8443/ in your browser. Sign in as admin to load the status data. You should see the three starter checks, local-https, local-tcp and local-dns, in the loopback group.

Certificate warning

The certificate is self-signed, created for this instance for localhost and 127.0.0.1, so your browser does not trust it by default. Compare the fingerprint your browser shows with the one on the instance before you continue:

sudo openssl x509 -in /var/lib/gatus/tls/cert.pem -noout -sha256 -fingerprint

7. Add your own endpoints¶

The starter checks only watch the instance itself. Add the endpoints you want to monitor, as described in Configuration.