알림¶
BombVault는 백업이 실패했을 때, 성공했을 때, 기한을 넘겼을 때, 그리고 일주일에 한 번 전체 현황을 알려 줄 수 있습니다. 모든 설정은 설정, 알림에 있습니다. 무엇이 메시지를 보낼지는 알림 카드, 메시지를 어디로 보낼지는 채널 카드, 체크인 ping은 Healthchecks 카드에서 정합니다.
메시지를 보내는 조건¶
알림 카드의 규칙은 모든 채널에 한꺼번에 적용됩니다.
- 알림: 아래의 모든 채널에 대해 안 함, 실패 시에만, 성공 및 실패 시 중에서 고릅니다. 새로 설치하면 실패 시에만으로 시작하므로, 채워 넣은 채널은 백업이 실패할 때 알려 줍니다.
- 예약 실행 요약: 컨테이너나 VM마다 메시지를 하나씩 보내는 대신, 예약 실행 한 번에 메시지 하나를 보냅니다. 예를 들어 45개 중 42개 성공처럼요. 직접 시작한 백업은 여전히 자기 메시지를 따로 보냅니다. 멈춘 게스트, 실패한 보존 정리, 넘어선 증가 예산은 요약을 켜 두어도 바로 전달됩니다.
- 컨테이너 업데이트 시 알림: 백업 성공 후 컨테이너 업데이트로 더 새로운 이미지로 올라간 컨테이너마다 메시지를 하나씩 보내서, 여전히 잘 동작하는지 확인할 수 있게 합니다.
- 지연된 백업 보고: 매일 09:00에 BombVault가 켜져 있는 백업 중 기한을 넘긴 것이 있는지 확인합니다. 일정 주기의 두 배보다 오래되면 기한을 넘긴 것이며, 해당하는 건마다 뒤처진 항목의 이름을 담아 메시지를 하나씩 보냅니다. 다음 백업이 성공하면 해소됩니다.
- Unraid 알림: Unraid 자체 알림 시스템으로 보내며, 거기서 Pushover, 이메일, Discord 등으로 전달할 수 있습니다. 설정, 연동, 호스트 SSH의 SSH 연결을 통해 실행되므로 그 키가 승인되어 있어야 합니다. TrueNAS나 다른 호스트에서는 꺼진 채로 있습니다.
- 주간 요약: 일주일에 한 번, 실행 횟수, 새로 생긴 백업 데이터, 기한을 넘긴 섹션, 오프사이트 사본이 최신인지, 가장 많이 실패한 항목을 요약해서 보냅니다. 이 계획도 다른 계획처럼 버튼으로 고르며, 끄기를 고르면 꺼집니다. 일정을 참고하세요.
어떤 이상 징후가 메시지를 보낼지는 설정, 검증에서 정합니다. 이상 징후를 참고하세요. 미뤄진 백업은 기다리기 시작할 때 한 번, 기다림이 끝날 때 한 번 메시지를 보내며, 재시도할 때마다 보내지는 않습니다.
카드 아래쪽의 테스트 보내기는 켜져 있는 모든 채널로, 양식에 지금 들어 있는 값 그대로 테스트 메시지를 보내고, 실패한 채널은 하나하나 이름을 알려 줍니다. Healthchecks 체크에는 로그에 항목이 하나 남으며, 상태는 그대로입니다.
채널¶
각 채널은 채널 카드에 자기 스위치가 있고, 켜면 입력란이 나타납니다. 채널마다 따로, 각자의 제한 시간으로 보내므로 응답하지 않는 호스트 하나가 다른 채널을 붙잡지 않습니다. 어느 채널도 받지 못한 기한 초과, 예산, 이상 징후 알림은 다시 시도하며, 주간 요약도 마찬가지입니다. 백업 하나의 메시지나 요약 메시지는 한 번만 보냅니다.
| 채널 | 입력란 | 참고 |
|---|---|---|
| Webhook | Webhook URL, Webhook 형식 | 형식: Generic JSON, Discord, Slack, Gotify, ntfy. Generic JSON은 title, message, ok를 보냅니다. |
| Apprise | Apprise API URL, 태그(선택 사항) | Apprise API 컨테이너의 /notify/<key> 엔드포인트를 지정하면 100개가 넘는 서비스로 보낼 수 있습니다. 태그로 그 키 대상 중 일부만 고를 수 있습니다. |
| Matrix | Homeserver URL, 액세스 토큰, 방 ID | 토큰은 서버에만 남고 다시 표시되지 않습니다. |
| Gotify | 서버 URL, 앱 토큰, 실패 시 우선순위, 성공 시 우선순위 | 우선순위는 0부터 10까지이며, 기본값은 실패 8, 성공 5입니다. |
| 이메일 (SMTP) | SMTP 호스트, 포트, 암호화, 사용자 이름, 비밀번호, 보내는 주소, 받는 주소 | 암호화는 STARTTLS, TLS (implicit), None 중에서 고릅니다. |
Matrix 토큰, Gotify 앱 토큰, SMTP 비밀번호 같은 비밀 값은 암호화되어 저장됩니다. 저장된 비밀 값 아래에는 저장됨. 그대로 두려면 칸을 비워 두세요.라고 표시됩니다. 서버 주소를 바꾸면 BombVault는 예전 비밀 값을 새 주소로 보내지 않습니다. 입력란이 값을 다시 요구하며, 새로 입력하면 새 주소가 저장됩니다.
Healthchecks¶
Healthchecks.io 같은 서비스는 BombVault가 신호를 보내지 않으면 알람을 울립니다. 체크의 ping URL을 붙여 넣으면 BombVault는 모든 백업의 수명 주기 동안, 즉 시작할 때와 성공할 때, 또는 /fail로 실패할 때 그 주소에 ping을 보냅니다. URL이 설정되어 있으면 알림을 어떻게 정했든 보내므로, 실패 시에만 메시지를 받도록 해 두어도 성공하면 체크는 계속 녹색입니다. 백업할 곳이 없는 섹션은 실패로 치므로, 그 체크는 성공 신호 대신 빨간색이 됩니다.
같은 URL을 쓰는 섹션은 체크 하나를 함께 씁니다. 그중 하나의 백업이 실패하면 다른 섹션의 정상 백업도 /fail로 ping을 보내며 실패한 섹션의 이름을 알리므로, 그 항목에 다시 정상 백업이 생기거나 조치 필요에서 실패를 확인할 때까지 체크는 빨간색으로 남습니다.
섹션마다 고유한 주소로 ping을 보낼 수도 있습니다. 카드에서 예외를 누르면 하나가 추가되며, 그 줄에는 나머지 모든 섹션이 이 URL로 ping을 보냅니다.라고 표시됩니다.
예제: 휴대폰의 Gotify¶
https://gotify.example.com에서 Gotify를 운영하고 있고, 실패는 휴대폰에서 소리로 알리고 성공은 조용히 받고 싶다고 해 봅시다.
- Gotify에서 Apps를 열고
BombVault라는 애플리케이션을 만든 다음 토큰을 복사합니다. - BombVault에서 설정, 알림을 엽니다. 알림 카드에서 알림을 성공 및 실패 시로 두고 예약 실행 요약을 켭니다. 그러면 백업 45개가 도는 밤에도 메시지가 45개가 아니라 하나만 옵니다.
- 채널에서 Gotify를 켭니다.
- 서버 URL에
https://gotify.example.com을 입력합니다./message는 BombVault가 알아서 붙입니다. - 앱 토큰에 토큰을 붙여 넣습니다.
- 실패 시 우선순위는 8, 성공 시 우선순위는 5로 그대로 둡니다. Gotify의 Android 앱은 8 이상을 높음으로 처리하므로 실패만 소리가 납니다.
- 테스트 보내기를 누릅니다. 카드 아래의 줄에 Gotify가 받았는지 표시되며, 토큰이 거부되면 그렇게 알려 줍니다.
다음 예약 실행부터는 요약 메시지 하나가 우선순위 5로 오고, 그 안에 실패가 있으면 우선순위 8로 옵니다.
예제: Webhook으로 쓰는 ntfy¶
공개 토픽에는 ntfy 계정이 필요 없습니다. 토픽 이름을 알면 누구나 읽을 수 있으니, 추측하기 어려운 이름을 고르세요.
- 채널에서 Webhook을 켭니다.
- Webhook URL에 토픽 주소를 입력합니다. 예를 들면
https://ntfy.sh/bombvault-tower-7f3k이며, 직접 운영하는 ntfy 서버의 주소여도 됩니다. - Webhook 형식을 ntfy로 설정합니다.
- ntfy 앱에서 같은 토픽을 구독하고 테스트 보내기를 누릅니다.
BombVault는 메시지를 본문으로 보내고 제목은 X-Title에 넣습니다. 실패는 우선순위 높음과 warning 태그로 나가서 앱에서 눈에 띕니다.
메시지가 도착하지 않을 때¶
문제 해결의 알림이 오지 않을 때를 참고하세요.