Repolode
bnlqn

bnlqn/overlook

Uma página única e auto-hospedada que mostra se seu homelab está funcionando bem, consultando as ferramentas que você já usa sem alterar nada.

Estrelas
202
Forks
11
Issues abertas
15
Último commit
anteontem

O que é?

Overlook é uma página de status somente leitura para homelabs. Ela consulta o estado das ferramentas de monitoramento e infraestrutura que você já usa, como Gatus, Uptime Kuma, Prometheus, Proxmox VE, UniFi, AdGuard Home e Jellyfin, e mostra em uma única página o que está com problemas, como cada área (Servers, Network, Storage, Apps) está e o que aconteceu hoje e nesta semana.

A ferramenta não executa verificações nem envia alertas próprios. Os problemas exibidos na página são as falhas que seu mecanismo de verificação existente já alerta, então a página e seus alertas estão alinhados. Ela não mantém um banco de dados: consulta cada fonte quando a página é solicitada, no máximo a cada 30 segundos. As chaves de API ficam no servidor e nunca são enviadas ao navegador.

Overlook é distribuído como uma única imagem de container para amd64 e arm64 ou como um binário Linux, e é configurado com um único arquivo YAML, que lê os segredos das variáveis de ambiente.

Recursos principais

  • 01Mostra o que está com problemas, com base nas falhas que seu mecanismo de verificação existente alerta.
  • 02Consulta Gatus, Uptime Kuma, Grafana, Prometheus, Proxmox VE, Beszel, Docker, UniFi e muitas outras ferramentas.
  • 03Envia apenas solicitações de leitura a cada fonte e nunca altera nada no seu homelab.
  • 04Não mantém um banco de dados e consulta as fontes sob demanda, no máximo a cada 30 segundos.
  • 05Mantém as chaves de API no servidor e lê os segredos das variáveis de ambiente.

Casos de uso

  • Ver rapidamente se um homelab auto-hospedado está funcionando bem antes de investigar as ferramentas individualmente.
  • Oferecer aos moradores uma página de status simples para serviços domésticos, como servidores de mídia e bibliotecas de fotos.
  • Reunir alertas de várias ferramentas de monitoramento em uma única visualização que corresponde ao que seus alertas informam.

Início rápido

  1. 1

    Escreva overlook.yaml e compose.yaml com as fontes que você executa

  2. 2

    Inicie o Overlook com Docker Compose e, em seguida, abra a porta 8080 desse host

    docker compose up -d

Antes de usar

  • Ele só mostra o que as ferramentas que você já usa informam, então é preciso já estar executando os apps compatíveis.
  • Algumas das chaves necessárias são chaves de administrador, como as do Radarr, Sonarr e AdGuard Home, que não têm opção somente leitura.

Em coleções

Tópicos

Perguntas frequentes

O que é overlook?
Uma página única e auto-hospedada que mostra se seu homelab está funcionando bem, consultando as ferramentas que você já usa sem alterar nada. Overlook é uma página de status somente leitura para homelabs. Ela consulta o estado das ferramentas de monitoramento e infraestrutura que você já usa, como Gatus, Uptime Kuma, Prometheus, Proxmox VE, UniFi, AdGuard Home e Jellyfin, e mostra em uma única página o que está com problemas, como cada área (Servers, Network, Storage, Apps) está e o que aconteceu hoje e nesta semana.
overlook é gratuito? Qual é a licença?
overlook é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
overlook ainda é mantido?
Manutenção ativa. O último commit de overlook foi em 5 de nov. de 2026.
Para que posso usar overlook?
Ver rapidamente se um homelab auto-hospedado está funcionando bem antes de investigar as ferramentas individualmente. Oferecer aos moradores uma página de status simples para serviços domésticos, como servidores de mídia e bibliotecas de fotos. Reunir alertas de várias ferramentas de monitoramento em uma única visualização que corresponde ao que seus alertas informam.
Como instalar overlook?
Escreva overlook.yaml e compose.yaml com as fontes que você executa Inicie o Overlook com Docker Compose e, em seguida, abra a porta 8080 desse host: docker compose up -d
Onde consigo overlook?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/bnlqn/overlook

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados