docs: Added readme info
All checks were successful
Build Docker / Build Image (push) Successful in 20s

This commit is contained in:
Nathan Woodburn 2023-11-08 14:05:55 +11:00
parent 3b7c587e54
commit 27af90fcc6
Signed by: nathanwoodburn
GPG Key ID: 203B000478AD0EF1
2 changed files with 18 additions and 1 deletions

3
.env.example Normal file
View File

@ -0,0 +1,3 @@
local=true
admin_ip=127.0.0.1
cookie=s%3A...

View File

@ -1 +1,15 @@
# faucet
# Woodburn Faucet
A simple faucet for Handshake domains
Running on [faucet.woodburn.au](https://faucet.woodburn.au)
## Docker deployment
```
docker run -d \
--name=faucet \
-e admin_ip=<your-IP> \
-e cookie=<your-nb-main-cookie>
-p 5000:5000 \
git.woodburn.au/nathanwoodburn/faucet:latest
```