Gatus

Automated developer-oriented status page with alerting and incident support.

Accessing Gatus

  • Öffnen Sie Ihren Browser und besuchen Sie: https://<SERVER_IP>
  • Eine SSL-Warnung im Browser ist zu erwarten (selbstsigniertes Zertifikat).
  • Authentication is required (Basic Auth popup)
  • Authentication method: HTTP Basic Auth
  • Credentials are stored securely in: /root/.cloudzy-creds

Wichtige Dateien und Verzeichnisse

  • Installationsverzeichnis: /opt/gatus
  • Docker Compose: /opt/gatus/docker-compose.yml
  • Umgebungsdatei: /opt/gatus/.env
  • Config directory: /opt/gatus/config/
  • Hauptkonfigurationsdatei: /opt/gatus/config/config.yaml
  • Database directory: /opt/gatus/data/db
  • Nginx-Konfiguration: /etc/nginx/sites-available/gatus.conf
  • Nginx-Site aktiviert: /etc/nginx/sites-enabled/gatus.conf
  • SSL-Zertifikate: /etc/nginx/ssl/
  • HTTP Basic Auth file: /etc/nginx/auth/.gatus-htpasswd
  • Anmeldedaten-Datei: /root/.gatus-credentials

Configuration Behavior

  • Configuration files are located in /opt/gatus/config/
  • YAML can be split into multiple files
  • Changes are auto-reloaded
  • No restart is required after edits

Den Stack verwalten

Go to the installation directory:

cd /opt/gatus

Common Docker Compose commands:

# Check status
docker compose ps

# View logs (follow live)
docker compose logs -f

# Restart all services
docker compose restart

# Stop services
docker compose down

# Start again
docker compose up -d

Disable HTTP Basic Auth in Nginx (Optional)

Edit the Nginx site file: /etc/nginx/sites-available/gatus.conf

Remove or comment out these lines:

auth_basic "Restricted";
auth_basic_user_file /etc/nginx/auth/.gatus-htpasswd;

Nginx neu laden:

systemctl restart nginx

SSL mit einer Domain aktivieren

1. Richten Sie Ihre Domain auf die Server-IP aus.

2. Bearbeiten Sie die Nginx-Konfiguration und ersetzen Sie beide server_name <IP>; mit Ihrer Domain (<your-domain>) sowohl für HTTP- (Port 80) als auch für HTTPS-Blöcke (Port 443):

vim /etc/nginx/sites-available/gatus.conf

3. Certbot installieren:

apt install -y certbot python3-certbot-nginx

4. Führen Sie den folgenden Befehl aus, um ein gültiges Let's Encrypt-Zertifikat zu generieren:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

5. Ersetzen Sie die SSL-Pfade in der Nginx-Konfiguration:

vim /etc/nginx/sites-available/gatus.conf
# Before:
    # ssl_certificate       /etc/nginx/ssl/fullchain.pem;
    # ssl_certificate_key   /etc/nginx/ssl/privkey.pem;
# After:
    # ssl_certificate       /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    # ssl_certificate_key   /etc/letsencrypt/live/yourdomain.com/privkey.pem;

6. Starten Sie Nginx neu, um die Änderungen zu übernehmen:

systemctl restart nginx

7. Öffnen Sie Ihren Browser und besuchen Sie: https://yourdomain.com

Anwendungsdetails