bnlqn/overlook

어떤 프로젝트인가요?

핵심 기능

• 01기존 점검 엔진이 알림을 보내는 장애를 바탕으로 문제 상황을 보여 줍니다.
• 02Gatus, Uptime Kuma, Grafana, Prometheus, Proxmox VE, Beszel, Docker, UniFi 등 다양한 도구에서 데이터를 읽어옵니다.
• 03각 데이터 소스에 읽기 요청만 보내며 홈랩의 어떤 설정도 변경하지 않습니다.
• 04데이터베이스를 사용하지 않고 필요할 때 데이터 소스를 조회하며, 조회 주기는 최대 30초입니다.
• 05API 키는 서버에 보관하고 비밀 값은 환경 변수에서 읽어옵니다.

활용 사례

• 개별 도구를 확인하기 전에 셀프 호스팅 홈랩이 정상인지 한눈에 파악할 때.
• 가족에게 미디어 서버나 사진 라이브러리 같은 홈 서비스의 상태를 보여 주는 간단한 페이지를 제공할 때.
• 여러 모니터링 도구의 알림을 알림 내용과 일치하는 하나의 화면에 모아 볼 때.

빠른 시작

1. 1

   실행할 소스를 지정해 overlook.yaml과 compose.yaml을 작성합니다

2. 2

   Docker Compose로 Overlook를 시작한 다음 해당 호스트의 포트 8080을 엽니다

   docker compose up -d

사용 전 알아둘 점

• !기존 도구가 보고하는 내용만 표시하므로 지원되는 앱을 이미 실행하고 있어야 합니다.
• !Radarr, Sonarr, AdGuard Home 등에 필요한 키 중 일부는 관리자 키입니다. 이러한 앱에는 읽기 전용 옵션이 없습니다.

포함된 컬렉션

토픽

자주 묻는 질문

overlook은(는) 무엇인가요?

이미 운영 중인 도구의 데이터를 읽어 홈랩 상태를 한 페이지에 보여 주는 셀프 호스팅 대시보드입니다. Overlook은 홈랩용 읽기 전용 상태 페이지입니다. Gatus, Uptime Kuma, Prometheus, Proxmox VE, UniFi, AdGuard Home, Jellyfin 등 이미 운영 중인 모니터링 및 인프라 도구에서 상태를 가져와, 문제 상황과 각 영역(Servers, Network, Storage, Apps)의 상태, 오늘과 이번 주에 발생한 일을 한 페이지에 정리합니다.

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

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

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

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

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

개별 도구를 확인하기 전에 셀프 호스팅 홈랩이 정상인지 한눈에 파악할 때. 가족에게 미디어 서버나 사진 라이브러리 같은 홈 서비스의 상태를 보여 주는 간단한 페이지를 제공할 때. 여러 모니터링 도구의 알림을 알림 내용과 일치하는 하나의 화면에 모아 볼 때.

overlook는 어떻게 설치하나요?

실행할 소스를 지정해 overlook.yaml과 compose.yaml을 작성합니다 Docker Compose로 Overlook를 시작한 다음 해당 호스트의 포트 8080을 엽니다: docker compose up -d

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

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