From b4beda8eb43b4948be5dc0dc2aba8d02c7e655e4 Mon Sep 17 00:00:00 2001 From: Anant Date: Wed, 7 Oct 2026 01:37:28 +0530 Subject: [PATCH] docs: point contributors to public Relay app setup --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf92c6b..728676f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ For app development, configure the mobile app to use these loopback Relay and ch ## Pair with the public Signing Server -Use Docker Compose 2.24.4 or newer for this optional stack. The public Signing Server supports installation, compilation and unit tests on its own. Its local Docker adapter is published in [app PR #7014](https://github.com/KeeperCommunity/bitcoin-keeper/pull/7014), which is still under review. The following commands pin the public adapter and the public Signing Server revision it supports. They do not fetch the older private Relay pin from that app setup. +Use Docker Compose 2.24.4 or newer for this optional stack. The public Signing Server supports installation, compilation and unit tests on its own. Its local Docker adapter is published in [app PR #7014](https://github.com/KeeperCommunity/bitcoin-keeper/pull/7014), which is still under review. The following commands pin that public adapter and the public Signing Server revision it supports. The app PR's full bootstrap now also pins this public Relay source. From inside this Relay checkout: @@ -30,7 +30,7 @@ RELAY_SOURCE_DIR="$PWD" git clone --filter=blob:none --sparse --branch codex/contributor-dev-environment https://github.com/KeeperCommunity/bitcoin-keeper.git ../keeper-public-local-adapter cd ../keeper-public-local-adapter git sparse-checkout set dev/local-backend -git checkout 9878d64e8f363970f686852caeb94df540d3e81a +git checkout 7519452ce32edd6579284ec278c6ae98b796b931 ./dev/local-backend/dev prepare-signing export SIGNING_SOURCE_DIR="$PWD/dev/local-backend/.sources/signing" cd "$RELAY_SOURCE_DIR" @@ -41,7 +41,7 @@ curl --fail http://127.0.0.1:3003/health This prepares Signing Server revision `b82dc4f4a8f75676b70b12545d59c7906556a92b`, verifies the adapter checksums, and starts the services behind a loopback gateway on ports 3000, 4002 and 3003. Relay, Mongo and Signing Server share an internal network with no external egress; only the gateway has host access. Signing Server creates independent disposable development identities in its named volume; preserve that volume together with Mongo when reusing local records. Do not export its contents. Local push delivery and scheduled jobs are disabled; email is captured inside the local signing volume and is never delivered. -Stop this stack with `docker compose -f compose.local.yaml -f compose.local-with-signing.yaml down`. This retains the Mongo and signing volumes. The pairing verifies local service availability; bitcoin signing, recovery, inheritance and timer-dependent behavior need their own separate checks. The app's full bootstrap will need its Relay source pin updated after this clean candidate is published. +Stop this stack with `docker compose -f compose.local.yaml -f compose.local-with-signing.yaml down`. This retains the Mongo and signing volumes. The pairing verifies local service availability; bitcoin signing, recovery, inheritance and timer-dependent behavior need their own separate checks. For the complete app contributor stack, run `./dev/local-backend/dev up` from the pinned app checkout above. The paired setup was checked on October 6, 2026 with the public revisions above: both health endpoints, synthetic Relay record create/read/update/clear, Socket.IO polling and WebSocket connections, and rejection of an unauthenticated Signing Server setup request passed. These checks used isolated local ports and disposable volumes.