docs: describe the layout
This commit is contained in:
16
README.md
Normal file
16
README.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# relay-tooling
|
||||||
|
|
||||||
|
Operator tooling for the Chum Bucket Relay link.
|
||||||
|
|
||||||
|
## Layout
|
||||||
|
|
||||||
|
deploy/relay.sh bring the tunnel up on a fresh jump host
|
||||||
|
bin/healthcheck.sh probe the relay and exit non-zero if it is down
|
||||||
|
bin/rotate-token.sh ask the relay to mint a new operator token
|
||||||
|
.env.example copy to .env and fill in, never commit the result
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
Credentials live in `.env`, which is gitignored. If you need a token, run
|
||||||
|
`bin/rotate-token.sh` against a host you control rather than copying one out of
|
||||||
|
a running box.
|
||||||
Reference in New Issue
Block a user