From 21cb94baaf7a6fd125153c7b2bb91c839b87f174 Mon Sep 17 00:00:00 2001 From: Rick Pat Date: Thu, 4 Sep 2025 09:41:03 +0000 Subject: [PATCH] docs: describe the layout --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebbe5e1 --- /dev/null +++ b/README.md @@ -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.