Portainer Templates logo

Portainer Templates

Gatus Gatus

Container

MonitoringNetworking

Automated developer-oriented status page with highly configurable health checks. Source: https://github.com/TwiN/gatus

Image details

Pulls: 60.4M
Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 24 MB
Latest: v5.36.0
User: twinproduction
Created: Sep 14, 2019
Updated: 21 days ago
Status: active

Source details

Repo: TwiN/gatus
Stars: 11.8k
Forks: 797
Language: Go
License: Apache-2.0
Latest: v5.36.0 · 2 months ago
Updated: 1 day ago
Website: gatus.io/

Configuration

Type
Container
Platform
linux
Image
twinproduction/gatus:stable
Ports
8080:8080/tcp
Volumes
/config
Restart
unless-stopped

Notes

Mount a config.yaml into /config to define your health checks; Gatus starts with defaults if none is present.

Standalone Install

Select an install method, to see config/commands for deploying Gatus

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Gatus, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see TwiN/gatus for app-specific guidance.

Gatus
build Go Report Card codecov Go version Docker pulls Follow TwiN
Gatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS queries as well as evaluate the result of said queries by using a list of conditions on values like the status code, the response time, the certificate expiration, the body and many others. The icing on top is that each of these health checks can be paired with alerting via Slack, PagerDuty, Pushover, Discord, Twilio and more.
I personally deploy it in my Kubernetes cluster and let it monitor the status of my core applications: https://status.twin.sh/
Quick start
docker run -p 8080:8080 --name gatus twinproduction/gatus
You can also use GitHub Container Registry if you prefer: 
docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus
For more details, see Usage

❤ Like this project? Please consider sponsoring me.

Gatus dashboard
Have any feedback or questions? Create a discussion.
See https://github.com/TwiN/gatus for the documentation

Serve Gatus on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying gatus.example.com to http://gatus:8080

Add this to your Caddyfile

gatus.example.com {
	reverse_proxy http://gatus:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs gatus
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8080 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8080
  • Stop the other service, or pick a different host port. In 8080:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8080. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, gatus can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8080

Image won't pull

Test the pull directly on the host: docker pull twinproduction/gatus:stable

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect gatus --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Gatus runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Gatus needs bundled into one download. This template pulls twinproduction/gatus:stable, which Docker fetches once (about 24 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Gatus's comes from Docker Hub, published by twinproduction.

Version tags

The bit after the colon in the image name is the version tag. This one pins stable, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8080:8080 means it's reachable on port 8080 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8080 in a browser. It opens:

  • 8080:8080, likely the web interface

Volumes

A volume is where Gatus keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config as a volume Docker manages for you

Restart policy

The restart policy here is unless-stopped, so Docker restarts Gatus after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Gatus sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container gatus. That's what you'll spot in the containers list and use in commands like docker logs gatus.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Gatus is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Gatus up. Add the template list to Portainer once, then deploying Gatus is a click rather than a wall of config.