adinhodovic/compass

어떤 프로젝트인가요?

핵심 기능

• 01Docker, Kubernetes, Tailscale, Headscale에서 서비스를 자동으로 검색합니다.
• 02정적 설정 및 JSON API 소스를 지원합니다.
• 03소스의 상태 및 새로고침 상태를 표시합니다.
• 04검색, 필터링, 태그, 서비스 메타데이터를 제공합니다.
• 05Docker 이미지와 Kubernetes용 Helm chart를 제공합니다.

활용 사례

• 홈랩의 여러 Docker 호스트에서 실행되는 서비스를 하나의 대시보드로 모아 관리하기.
• 팀에서 내부 Kubernetes 서비스와 링크를 한곳에 정리하기.
• 한 페이지에서 Tailscale 또는 Headscale 네트워크에 노출된 서비스 둘러보기.

빠른 시작

1. 1

   Docker 소스를 지정한 compass.yaml을 만듭니다

2. 2

   Docker로 Compass 컨테이너를 실행합니다

   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

   Kubernetes를 사용하는 경우 Kubernetes 소스를 지정한 compass.yaml을 만듭니다

4. 4

   Helm으로 Compass를 설치합니다

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

사용 전 알아둘 점

• !Docker 검색에는 Docker 소켓을 마운트해야 하며, 이 경우 호스트의 민감한 리소스에 접근할 수 있습니다.
• !Kubernetes 검색은 Helm 차트에 부여된 클러스터 내부 RBAC 권한에 따라 달라집니다.

포함된 컬렉션

토픽

자주 묻는 질문

compass은(는) 무엇인가요?

Docker, Kubernetes, Tailscale에서 서비스와 대시보드, 문서를 자동으로 찾아 목록으로 보여주는 셀프 호스팅 랜딩 페이지입니다. Compass는 홈랩 및 셀프 호스팅 환경을 위한 랜딩 페이지입니다. 서비스마다 카드를 직접 작성해 관리하는 대신 YAML 설정에 소스를 추가하면 Compass가 해당 소스에서 제공하는 항목을 서버 주도 UI로 렌더링합니다.

compass은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

compass은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

compass은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. compass의 마지막 커밋은 2026년 11월 5일입니다.

compass은(는) 어디에 사용할 수 있나요?

홈랩의 여러 Docker 호스트에서 실행되는 서비스를 하나의 대시보드로 모아 관리하기. 팀에서 내부 Kubernetes 서비스와 링크를 한곳에 정리하기. 한 페이지에서 Tailscale 또는 Headscale 네트워크에 노출된 서비스 둘러보기.

compass는 어떻게 설치하나요?

Docker 소스를 지정한 compass.yaml을 만듭니다 Docker로 Compass 컨테이너를 실행합니다: 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 Kubernetes를 사용하는 경우 Kubernetes 소스를 지정한 compass.yaml을 만듭니다 Helm으로 Compass를 설치합니다: helm install compass oci://ghcr.io/adinhodovic/charts/compass -n compass --create-namespace --set-file config=compass.yaml

compass은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/adinhodovic/compass