From ead4591fd3901726760d77868cc38dc63c58ba9d Mon Sep 17 00:00:00 2001 From: nmfretz Date: Mon, 18 Nov 2024 23:50:09 +1000 Subject: [PATCH] Make Fulcrum interchangeable with other Electrum Server re-implementations --- fulcrum/data/fulcrum-logs/.gitkeep | 0 fulcrum/docker-compose.yml | 13 ++++++++----- fulcrum/exports.sh | 15 +++++++++++++++ fulcrum/hooks/pre-start | 6 ++++++ fulcrum/umbrel-app.yml | 16 +++++++++++----- 5 files changed, 40 insertions(+), 10 deletions(-) create mode 100644 fulcrum/data/fulcrum-logs/.gitkeep mode change 100644 => 100755 fulcrum/hooks/pre-start diff --git a/fulcrum/data/fulcrum-logs/.gitkeep b/fulcrum/data/fulcrum-logs/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/fulcrum/docker-compose.yml b/fulcrum/docker-compose.yml index ea59e5aef..13315dee2 100644 --- a/fulcrum/docker-compose.yml +++ b/fulcrum/docker-compose.yml @@ -7,20 +7,21 @@ services: APP_PORT: 3006 app: - image: ghcr.io/sahilph/umbrel-fulcrum:sha-349e246@sha256:5d565f3b15f7bbeab28c027320ffc84d647e7816cd007fd84077c0db05c15393 + image: nmfretz/umbrel-fulcrum:1.0.0@sha256:fd8a45f757e11ae1526b650ee5179d25f469d9b371163466fead08c70aab9d41 depends_on: - fulcrum restart: on-failure environment: ELECTRUM_HIDDEN_SERVICE: "${APP_FULCRUM_RPC_HIDDEN_SERVICE}" ELECTRUM_LOCAL_SERVICE: "${DEVICE_DOMAIN_NAME}" - ELECTRUM_PORT: ${APP_FULCRUM_NODE_PORT} - FULCRUM_HOST: "${APP_FULCRUM_NODE_IP}" - FULCRUM_PORT: "${APP_FULCRUM_NODE_PORT}" + ELECTRUM_HOST: "${APP_FULCRUM_NODE_IP}" + ELECTRUM_PUBLIC_CONNECTION_PORT: ${APP_FULCRUM_NODE_PORT} BITCOIN_HOST: "${APP_BITCOIN_NODE_IP}" RPC_USER: "${APP_BITCOIN_RPC_USER}" RPC_PASSWORD: "${APP_BITCOIN_RPC_PASS}" RPC_PORT: "${APP_BITCOIN_RPC_PORT}" + volumes: + - "${APP_DATA_DIR}/data/fulcrum-logs:/fulcrum-logs" networks: default: ipv4_address: $APP_FULCRUM_IP @@ -31,14 +32,16 @@ services: user: "1000:1000" environment: TCP: 0.0.0.0:${APP_FULCRUM_NODE_PORT} + ADMIN: 0.0.0.0:${APP_FULCRUM_ADMIN_PORT} BITCOIND: ${APP_BITCOIN_NODE_IP}:${APP_BITCOIN_RPC_PORT} RPCUSER: ${APP_BITCOIN_RPC_USER} RPCPASSWORD: ${APP_BITCOIN_RPC_PASS} PEERING: "false" ANNOUNCE: "false" - command: Fulcrum _ENV_ + command: sh -c 'Fulcrum -D /data _ENV_ 2>&1 | tee /logs/fulcrum.log' volumes: - "${APP_DATA_DIR}/data/fulcrum:/data" + - "${APP_DATA_DIR}/data/fulcrum-logs:/logs" ports: - "${APP_FULCRUM_NODE_PORT}:${APP_FULCRUM_NODE_PORT}" networks: diff --git a/fulcrum/exports.sh b/fulcrum/exports.sh index 34a1c6082..ee16104a3 100644 --- a/fulcrum/exports.sh +++ b/fulcrum/exports.sh @@ -2,6 +2,21 @@ export APP_FULCRUM_IP="10.21.22.200" export APP_FULCRUM_NODE_IP="10.21.21.200" export APP_FULCRUM_NODE_PORT="50002" +export APP_FULCRUM_ADMIN_PORT="8000" + +for var in \ + IP \ + NODE_IP \ + NODE_PORT \ +; do + electrs_var="APP_ELECTRS_${var}" + fulcrum_var="APP_FULCRUM_${var}" + if [ -n "${!fulcrum_var-}" ]; then + export "$electrs_var"="${!electrs_var:=${!fulcrum_var}}" + else + echo "Warning: $fulcrum_var is unset or empty" + fi +done rpc_hidden_service_file="${EXPORTS_TOR_DATA_DIR}/app-${EXPORTS_APP_ID}-rpc/hostname" export APP_FULCRUM_RPC_HIDDEN_SERVICE="$(cat "${rpc_hidden_service_file}" 2>/dev/null || echo "notyetset.onion")" diff --git a/fulcrum/hooks/pre-start b/fulcrum/hooks/pre-start old mode 100644 new mode 100755 index 7cf6e7e4f..b95018038 --- a/fulcrum/hooks/pre-start +++ b/fulcrum/hooks/pre-start @@ -1,5 +1,11 @@ #!/usr/bin/env bash +# If ${APP_DATA_DIR}/data/fulcrum-logs doesn't exist, we create it and set 1000:1000 ownership +if [[ ! -d "${APP_DATA_DIR}/data/fulcrum-logs" ]]; then + mkdir -p "${APP_DATA_DIR}/data/fulcrum-logs" + chown 1000:1000 "${APP_DATA_DIR}/data/fulcrum-logs" +fi + # Delay booting Fulcrum until the RPC Tor Hidden Service is ready HIDDEN_SERVICE_FILE="${TOR_DATA_DIR}/app-${APP_ID}-rpc/hostname" diff --git a/fulcrum/umbrel-app.yml b/fulcrum/umbrel-app.yml index cb77d7699..3f2cb3b3b 100644 --- a/fulcrum/umbrel-app.yml +++ b/fulcrum/umbrel-app.yml @@ -1,8 +1,10 @@ manifestVersion: 1.1 id: fulcrum +implements: + - electrs category: bitcoin name: Fulcrum -version: "1.11.1" +version: "1.11.1-swappable" tagline: A fast and nimble Electrum Server description: >- Run your personal Electrum server and connect your Electrum-compatible wallet, @@ -12,9 +14,6 @@ description: >- Powered by Fulcrum from Calin Culianu - - - ⚠️ Fulcrum does not yet automatically integrate with other apps in the Bitcoin ecosystem on Umbrel. However, in a future umbrelOS update, users will be able to choose which Electrum Server app they want to use to connect with other apps. developer: Calin Culianu website: https://fulcrumserver.org/ submitter: Sahil Phule @@ -30,4 +29,11 @@ gallery: - 3.jpg path: "" defaultPassword: "" -releaseNotes: "" +releaseNotes: >- + Fulcrum now integrates seamlessly with other apps, allowing you to connect to compatible apps like Bitcoin nodes and block explorers. + + + To switch an existing app to connect to Fulcrum, right-click the app and update the connection in “Settings.” + + + ⚠️ Note: This feature requires umbrelOS 1.3 or later.