diff --git a/doc/CYPHERAPPS.md b/doc/CYPHERAPPS.md new file mode 100644 index 0000000..44263ee --- /dev/null +++ b/doc/CYPHERAPPS.md @@ -0,0 +1,17 @@ +# Cyphernode Apps + +We are providing one default Cyphernode application: The Cyphernode Welcome App. It is a simple Golang application that uses the Cyphernode API to get some information about it: the Bitcoin Core syncing progression, the installed components, a link to download the encrypted config file, a link to download the encrypted API ID/keys file and a link to Spark Wallet, if LN is installed. + +We are also providing Spark Wallet as a Cyphernode application. It is a hybrid application, directly using the c-lightning directory instead of only using the Cyphernode API. + +## Concept + +As you already know it, we want Cyphernode to be modular and decoupled. That's why we created a completely separated repository for the Cyphernode Apps: https://github.com/SatoshiPortal/cypherapps + +Cypherapps acts as an indirection layer between Cyphernode and the actual applications. The repo is cloned into the Cyphernode directory during setup, depending on the selected optional features. The corresponding docker images are taken from our Docker hub. + +Separating Cypherapps from Cyphernode allows us to add applications without changing Cyphernode. + +## Examples + +Welcome App: https://github.com/SatoshiPortal/cyphernode_welcome diff --git a/install/generator-cyphernode/generators/app/templates/installer/start.sh b/install/generator-cyphernode/generators/app/templates/installer/start.sh index 5ac9c51..b3038ee 100644 --- a/install/generator-cyphernode/generators/app/templates/installer/start.sh +++ b/install/generator-cyphernode/generators/app/templates/installer/start.sh @@ -19,9 +19,9 @@ start_apps() { APP_SCRIPT_PATH=$(echo $i) if [ -d "$APP_SCRIPT_PATH" ] && [ ! -f "$APP_SCRIPT_PATH/ignoreThisApp" ]; then APP_START_SCRIPT_PATH="$APP_SCRIPT_PATH/$SCRIPT_NAME" + APP_ID=$(basename $APP_SCRIPT_PATH) if [ -f "$APP_START_SCRIPT_PATH" ]; then - APP_ID=$(basename $APP_SCRIPT_PATH) . $APP_START_SCRIPT_PATH elif [ -f "$APP_SCRIPT_PATH/docker-compose.yaml" ]; then export SHARED_HTPASSWD_PATH diff --git a/install/generator-cyphernode/generators/app/templates/installer/stop.sh b/install/generator-cyphernode/generators/app/templates/installer/stop.sh index 247f7b7..88b28bc 100644 --- a/install/generator-cyphernode/generators/app/templates/installer/stop.sh +++ b/install/generator-cyphernode/generators/app/templates/installer/stop.sh @@ -20,9 +20,9 @@ stop_apps() { APP_SCRIPT_PATH=$(echo $i) if [ -d "$APP_SCRIPT_PATH" ] && [ ! -f "$APP_SCRIPT_PATH/ignoreThisApp" ]; then APP_STOP_SCRIPT_PATH="$APP_SCRIPT_PATH/$SCRIPT_NAME" + APP_ID=$(basename $APP_SCRIPT_PATH) if [ -f "$APP_STOP_SCRIPT_PATH" ]; then - APP_ID=$(basename $APP_SCRIPT_PATH) . $APP_STOP_SCRIPT_PATH elif [ -f "$APP_SCRIPT_PATH/docker-compose.yaml" ]; then export SHARED_HTPASSWD_PATH