From 675ab561d897742024fe5ff7902c10f3402fc68c Mon Sep 17 00:00:00 2001 From: Aaron Bieber Date: Thu, 12 Jan 2023 10:35:43 -0700 Subject: [PATCH] Add readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bcf468a --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +pots +==== + +A tool that fires off Tailscale logs to Pushover. + +# Usage + +This is intendet to be behind a reverse proxy that provedes HTTPS. + +You will need to set three environment variables: + +- `POTS_TOKEN`: This is a random string you generate. +- `PUSHOVER_USER`: Your Pushover user token. +- `PUSHOVER_TOKEN`: Your Pushover app token. + +## POTS_TOKEN + +This variable is used to give Tailscale a unique string that isn't easily guessed. + +For example, if you set`POTS_TOKEN=arstarst`, then you would point Tailscale's +webhook at `https://yourdomain/api/arstarst`.