Repolode
adinhodovic

adinhodovic/compass

Uma página inicial self-hosted que descobre e lista automaticamente seus serviços, dashboards e documentos do Docker, Kubernetes e Tailscale.

Estrelas
78
Forks
4
Issues abertas
3
Último commit
anteontem

O que é?

Compass é uma página inicial para homelabs e ambientes self-hosted. Em vez de manter cards escritos manualmente para cada serviço, você adiciona uma fonte a uma configuração YAML, e o Compass exibe o que essa fonte disponibiliza em uma interface renderizada no servidor.

As fontes compatíveis incluem Docker, Kubernetes, Tailscale, Headscale, configuração estática e endpoints de JSON API. A interface mostra a saúde e o status de atualização de cada fonte, metadados dos serviços, tags, painéis e visualizações de depuração, além de oferecer busca e filtros para os serviços.

O frontend é composto por HTML renderizado no servidor, usando HTMX, Alpine.js, Tailwind e daisyUI. Você pode executá-lo como um container Docker ou implantá-lo no Kubernetes com um Helm chart.

Recursos principais

  • 01Descobre serviços automaticamente no Docker, Kubernetes, Tailscale e Headscale.
  • 02Compatível com fontes de configuração estática e JSON API.
  • 03Exibe a saúde e o status de atualização das fontes.
  • 04Oferece busca, filtros, tags e metadados dos serviços.
  • 05Disponibiliza uma imagem Docker e um Helm chart para Kubernetes.

Casos de uso

  • Criar um dashboard único para serviços executados em vários hosts Docker de um homelab.
  • Listar serviços internos do Kubernetes e seus links em um só lugar para uma equipe.
  • Navegar pelos serviços disponíveis em uma rede Tailscale ou Headscale em uma única página.

Início rápido

  1. 1

    Crie compass.yaml com uma fonte Docker

  2. 2

    Execute o contêiner do Compass com Docker

    docker run --rm -p 8080:8080 --group-add $(getent group docker | cut -d: -f3) -v /var/run/docker.sock:/var/run/docker.sock:ro -v $PWD/compass.yaml:/etc/compass/compass.yaml:ro adinhodovic/compass:latest -c /etc/compass/compass.yaml
  3. 3

    Para Kubernetes, crie compass.yaml com uma fonte Kubernetes

  4. 4

    Instale o Compass com Helm

    helm install compass oci://ghcr.io/adinhodovic/charts/compass -n compass --create-namespace --set-file config=compass.yaml

Antes de usar

  • A descoberta do Docker exige montar o socket do Docker, o que concede acesso a informações sensíveis do host.
  • A descoberta do Kubernetes depende das permissões RBAC no cluster concedidas pelo chart do Helm.

Em coleções

Tópicos

Perguntas frequentes

O que é compass?
Uma página inicial self-hosted que descobre e lista automaticamente seus serviços, dashboards e documentos do Docker, Kubernetes e Tailscale. Compass é uma página inicial para homelabs e ambientes self-hosted. Em vez de manter cards escritos manualmente para cada serviço, você adiciona uma fonte a uma configuração YAML, e o Compass exibe o que essa fonte disponibiliza em uma interface renderizada no servidor.
compass é gratuito? Qual é a licença?
compass é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
compass ainda é mantido?
Manutenção ativa. O último commit de compass foi em 5 de nov. de 2026.
Para que posso usar compass?
Criar um dashboard único para serviços executados em vários hosts Docker de um homelab. Listar serviços internos do Kubernetes e seus links em um só lugar para uma equipe. Navegar pelos serviços disponíveis em uma rede Tailscale ou Headscale em uma única página.
Como instalar compass?
Crie compass.yaml com uma fonte Docker Execute o contêiner do Compass com Docker: docker run --rm -p 8080:8080 --group-add $(getent group docker | cut -d: -f3) -v /var/run/docker.sock:/var/run/docker.sock:ro -v $PWD/compass.yaml:/etc/compass/compass.yaml:ro adinhodovic/compass:latest -c /etc/compass/compass.yaml Para Kubernetes, crie compass.yaml com uma fonte Kubernetes Instale o Compass com Helm: helm install compass oci://ghcr.io/adinhodovic/charts/compass -n compass --create-namespace --set-file config=compass.yaml
Onde consigo compass?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/adinhodovic/compass

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

Projetos relacionados