Add readme

This commit is contained in:
Aaron Bieber 2023-01-12 10:35:43 -07:00
parent 88d5dfd499
commit 675ab561d8
No known key found for this signature in database

21
README.md Normal file
View File

@ -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`.