Gatus

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

Accessing Gatus

  • Abra o seu navegador e visite: https://<SERVER_IP>
  • É de esperar que o navegador exiba um aviso SSL (certificado autoassinado)
  • É necessária autenticação (janela pop-up de autenticação básica)
  • Método de autenticação: Autenticação básica HTTP
  • As credenciais são armazenadas de forma segura em: /root/.cloudzy-creds

Ficheiros e diretórios importantes

  • Diretório de instalação: /opt/gatus
  • Docker Compose: /opt/gatus/docker-compose.yml
  • Arquivo de ambiente: /opt/gatus/.env
  • Config directory: /opt/gatus/config/
  • Ficheiro de configuração principal: /opt/gatus/config/config.yaml
  • Database directory: /opt/gatus/data/db
  • Configuração do Nginx: /etc/nginx/sites-available/gatus.conf
  • Site Nginx ativado: /etc/nginx/sites-enabled/gatus.conf
  • Certificados SSL: /etc/nginx/ssl/
  • HTTP Basic Auth file: /etc/nginx/auth/.gatus-htpasswd
  • Arquivo de credenciais: /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

Gerir a pilha

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;

Recarregar o Nginx:

systemctl restart nginx

Ativar SSL com um domínio

1. Direcione o seu domínio para o IP do servidor.

2. Edite a configuração do Nginx e substitua ambos server_name <IP>; com o seu domínio (<your-domain>) para blocos HTTP (porta 80) e HTTPS (porta 443):

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

3. Instale o Certbot:

apt install -y certbot python3-certbot-nginx

4. Execute o seguinte comando para gerar um certificado Let’s Encrypt válido:

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

5. Substitua os caminhos SSL na configuração do Nginx:

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. Reinicie o Nginx para aplicar as alterações:

systemctl restart nginx

7. Abra o seu navegador e aceda a: https://yourdomain.com

Detalhes da candidatura