aljaz/cyphernode
1
0
Fork 0
mirror of https://github.com/aljazceru/cyphernode.git synced 2026-02-02 03:04:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Cypherapps docs and fix in start/stop

Browse Source
This commit is contained in:
kexkey
2019-04-09 13:20:16 -04:00
committed by kexkey
parent 7bc7f3b495
commit 6470b684a8
3 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/CYPHERAPPS.md Normal file
View File

@@ -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

2
install/generator-cyphernode/generators/app/templates/installer/start.sh
View File

@@ -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

2
install/generator-cyphernode/generators/app/templates/installer/stop.sh
View File

@@ -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