Como Instalar o Sistema de Página de Status Cachet no Debian 12

Cachet é um sistema de página de status de código aberto escrito em PHP. Ele permite que você monitore o tempo de inatividade e falhas no sistema em sua infraestrutura. O Cachet fornece API JSO, relatórios, métricas, múltiplos métodos de notificação e autenticação de dois fatores.

No tutorial a seguir, mostraremos como instalar a página de status do Cachet em um servidor Debian 12. Você executará o Cachet como um contêiner Docker com o banco de dados PostgreSQL e o servidor web Nginx.

Pré-requisitos

Antes de prosseguir, certifique-se de ter o seguinte:

• Um servidor Debian 12.
• Um usuário não-root com privilégios sudo.
• O UFW foi instalado e configurado.
• Um nome de domínio apontado para um endereço IP do servidor.

Instalando o Docker Engine

Neste exemplo, você instalará o Cachet como um contêiner via Docker. Portanto, você precisa instalar o engine Docker em seu sistema Debian. Neste exemplo, você usará os pacotes oficiais do engine Docker.

Primeiro, execute o comando abaixo para instalar os pacotes curl e ca-certificates.

sudo apt install ca-certificates curl -y

Agora adicione a chave GPG para o repositório Docker executando o seguinte comando.

sudo install -m 0755 -d /etc/apt/keyrings  
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc  
sudo chmod a+r /etc/apt/keyrings/docker.asc

Em seguida, adicione o repositório do Docker Engine para o sistema Debian usando o comando abaixo.

echo \  
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \  
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \  
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Uma vez que o repositório Docker foi adicionado, atualize e atualize seu índice de pacotes com o comando abaixo.

sudo apt update

Agora instale o Docker Engine em seu sistema com o seguinte comando. Digite Y para confirmar a instalação.

sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Após a conclusão da instalação, o serviço Docker deve estar em execução automaticamente. Verifique o status do serviço Docker com o comando abaixo.

sudo systemctl status docker

Você verá a saída em execução como a seguinte:

Para garantir que seu usuário possa executar e rodar o contêiner, você deve adicioná-lo ao grupo docker com o comando abaixo.

sudo usermod -aG sudo alice

Por último, faça login como seu usuário e execute o comando docker abaixo para rodar um contêiner hello-world.

su - alice  
docker run hello-world

Se sua configuração for bem-sucedida, você deve obter a saída ‘Hello Docker’ como a seguinte:

Executando o Cachet com Docker e banco de dados PostgreSQL

Depois de instalar o Docker, você precisa baixar o projeto Cachet e configurar sua instalação. Neste caso, você instalará e executará o Cachet como um usuário não-root com um contêiner Docker.

Baixe o projeto Cachet para o diretório cachet-docker e entre nele.

git clone https://github.com/cachethq/Docker.git cachet-docker  
cd cachet-docker

Abra o arquivo docker-compose.yml usando o seguinte comando do editor nano.

nano docker-compose.yml

Altere a porta do host padrão para 8000 como a seguinte. Você também pode personalizar os detalhes do banco de dados com suas informações e deixar a versão padrão do Cachet como 2.4 por enquanto.

 ports:  
 - 8000:8000

Salve o arquivo e saia.

Agora execute os seguintes comandos do docker para construir sua imagem Cached e executar contêineres para o Cachet e PostgreSQL.

docker compose build  
docker compose up

Abaixo, você pode ver a captura de tela de quando a imagem Docker para o Cachet está sendo construída.

Abaixo está a captura de tela ao executar contêineres/serviços para o Cachet e PostgreSQL.

Nos logs detalhados do contêiner Cachet, você encontrará um erro sobre a configuração APP_KEY. Copie a APP_KEY gerada e pressione Ctrl+c para encerrar os contêineres.

Em seguida, reabra o arquivo docker-compose.yml usando o editor nano.

nano docker-compose.yml

Altere o parâmetro APP_KEY padrão como a seguinte. Certifique-se de incluir a string base64.

APP_KEY=base64:WfKUhY0wAOyr5hkxoctZUSWPGdXbBUWFvNLCoI7kTU8=

Salve o arquivo e saia.

Agora execute o comando docker abaixo para encerrar os contêineres do Cachet e PostgreSQL e, em seguida, iniciá-los novamente.

docker compose down  
docker compose up -d

Uma vez que os contêineres iniciam, verifique a lista de contêineres em execução usando o seguinte comando.

docker compose ps

Como você pode ver abaixo, ambos os contêineres Cachet e PostgreSQL estão em execução. O contêiner Cachet está rodando na porta 8000.

Configurando o Nginx como um proxy reverso

Agora que o Cachet está em execução como um contêiner na porta 8000, você instalará e configurará o Nginx como um proxy reverso para o Cachet.

Instale o Nginx em seu servidor Debian usando o comando abaixo.

sudo apt install nginx -y

Uma vez que a instalação esteja completa, crie uma nova configuração de bloco de servidor Nginx /etc/nginx/sites-available/cachet usando o comando do editor nano abaixo.

sudo nano /etc/nginx/sites-available/cachet

Insira a configuração abaixo e certifique-se de alterar o parâmetro server_name com seu nome de domínio.

server {  
 listen 80;  
 server_name status.howtoforge.local;  
 location / {  
 proxy_pass http://127.0.0.1:8000;  
 proxy_set_header Host $host;  
 proxy_set_header X-Real-IP $remote_addr;  
 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
 proxy_set_header X-Forwarded-Proto $scheme;  
 }  
}

Salve o arquivo e saia do editor.

Em seguida, execute o comando Nginx abaixo para ativar o bloco de servidor Cachet e verificar sua sintaxe Nginx. Se você tiver uma sintaxe adequada, deverá obter uma saída ‘syntax is ok‘.

sudo ln -s /etc/nginx/sites-available/cachet /etc/nginx/sites-enabled/  
sudo nginx -t

Por último, reinicie o servidor web Nginx para aplicar a configuração do bloco de servidor Cachet e verifique o serviço Nginx para garantir que está em execução.

sudo systemctl restart nginx  
sudo systemctl status nginx

Se o Nginx estiver em execução, você deve obter uma saída active(running).

Configurando o UFW (Firewall Descomplicado)

Antes de acessar o Cachet, você deve garantir que as portas HTTP e HTTPS estejam permitidas. No Ubuntu, você permitirá o tráfego para ambos os protocolos HTTP e HTTPS via UFW (Firewall Descomplicado).

Certifique-se de que o UFW esteja habilitado, agora execute o seguinte comando para habilitar o perfil ‘Nginx Full‘ no UFW. Isso permitirá o tráfego para os protocolos HTTP e HTTPS em seu servidor web Nginx.

sudo ufw allow 'Nginx Full'

Agora verifique sua lista de regras habilitadas no UFW com o comando abaixo.

sudo ufw status

Você verá que o perfil ‘Nginx Full‘ está habilitado no UFW.

Protegendo o Cachet com HTTPS

Neste ponto, seu Cachet deve ser acessível via Nginx. Para proteger sua instalação, você habilitará HTTPS para o Cachet via SSL do Letsencrypt.

Então execute o comando abaixo para instalar o Certbot e o plugin Certbot Nginx. Digite Y para confirmar a instalação.

sudo apt install certbot python3-nginx-certbot

Uma vez que a instalação esteja completa, execute o comando certbot abaixo para gerar certificados SSL/TLS para sua instalação do Cachet. Certifique-se de alterar os detalhes do nome de domínio e endereço de e-mail com suas informações.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d status.howtoforge.local

Depois que tudo estiver completo, seus certificados SSL/TLS devem ser armazenados no diretório /etc/lestencrypt/live/status.howtoforge.local. Além disso, seu Cachet deve estar protegido via HTTPS.

Instalando o Cachet

Inicie seu navegador web preferido e visite sua instalação do Cachet https://status.howtoforge.local/. Se sua instalação for bem-sucedida, você deve obter a seguinte página.

Selecione o Cache Driver, Queue Driver e Session Driver padrão para o Database. Em seguida, insira os detalhes do seu servidor de e-mail.

Clique em Next para continuar.

Agora configure o nome da página de status, o fuso horário padrão e o idioma padrão. Em seguida, clique em Next novamente.

Agora crie um novo usuário administrador para o Cachet digitando seu nome de usuário, e-mail e senha. Em seguida, clique em Complete Setup para confirmar.

Uma vez concluído, você verá o seguinte - clique em Go to the dashboard.

Faça login no Cachet com seu nome de usuário e senha, e clique em Login.

Se sua instalação for bem-sucedida, você deve obter o painel do Cachet como o seguinte:

Conclusão

Parabéns! Você agora instalou a página de status do Cachet no servidor Debian 12 com Docker. Sua instalação do Cachet está rodando com um banco de dados PostgreSQL e servidor web Nginx. Agora você pode monitorar seus sites usando o Cachet.