shorten/README.md
ptrcnull a4b8c8c33f
Some checks failed
/ test (push) Has been cancelled
feat: add manually managed domain blacklist
2024-09-06 11:56:58 +02:00

16 lines
533 B
Markdown

# shorten
> simple url shortener
### Setup
Environmental variables:
- `SHORTEN_HOST` - hostname
- `SHORTEN_BIND` - bind address (default: `127.0.0.1:4488`)
- `SHORTEN_MAIL` - optional email for support/abuse reports
- `POSTGRES_URI` - lib/pq connection string (see [here](https://pkg.go.dev/github.com/lib/pq#section-documentation))
### Maintenance
shorten supports a domain blacklist to ban certain domains (e.g. spam, malware, etc.);
you can use it by connecting to the database and inserting rows into the `blacklist` table.