From 69e93c49a4b43fa5c65cea0dc1990a5ad545f7e5 Mon Sep 17 00:00:00 2001 From: BroodjeAap Date: Fri, 30 Dec 2022 13:52:17 +0000 Subject: [PATCH] Added apprise compose example in readme --- README.md | 33 +++++++++++++++++++++++++++++++++ todo.md | 3 --- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6244b7f..e6d6b8e 100644 --- a/README.md +++ b/README.md @@ -303,6 +303,39 @@ database: prune: "@every 1h" ``` +## Apprise + +[Apprise](https://github.com/caronc/apprise) can also be used to send notifications, it supports many different services/protocols, but it requires access to an [Apprise API](https://github.com/caronc/apprise-api). +Luckily there is a [docker image](https://hub.docker.com/r/caronc/apprise) available that we can add to our compose: +``` +version: "3" + +services: + app: + image: ghcr.io/broodjeaap/go-watch:master + container_name: go-watch + volumes: + - /host/path/to/:/config + ports: + - "8080:8080" + apprise: + image: caronc/apprise:latest +``` + +And the notifier config: +``` +notifiers: + apprise: + type: "apprise" + url: "http://apprise:8000/notify" + urls: + - "tgram:////" + - "discord:////" +database: + dsn: "watch.db" + prune: "@every 1h" +``` + ## Telegram Get a bot token from the [@BotFather](https://core.telegram.org/bots/tutorial) and get the [chatID](https://www.alphr.com/find-chat-id-telegram/) of the chat want to send the notifications to. diff --git a/todo.md b/todo.md index a6623e5..4de7e0d 100644 --- a/todo.md +++ b/todo.md @@ -1,7 +1,4 @@ # Todo -- make generic 'notifier' interface - - ~~apprise service~~ - - apprise compose example - comments - run/fix staticcheck - add browserless support ?