From 6013757e24fef4cfb4b4dd58bd795255157c77d8 Mon Sep 17 00:00:00 2001 From: Reckless_Satoshi Date: Mon, 22 Aug 2022 10:35:54 -0700 Subject: [PATCH] Fix github action workflow symlinks ignored --- .github/workflows/node-client-image.yml | 13 +++++++------ nodeapp/README.md | 16 +++++++++++++++- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/.github/workflows/node-client-image.yml b/.github/workflows/node-client-image.yml index ea5afa4b..669b06ff 100644 --- a/.github/workflows/node-client-image.yml +++ b/.github/workflows/node-client-image.yml @@ -1,4 +1,4 @@ -name: RoboSats Client Node App Image CI/CD +name: Client App Image CI/CD on: workflow_dispatch: @@ -20,13 +20,18 @@ jobs: steps: - uses: actions/checkout@v3 + - name: 'Copy Static' # Only needed because Github actions does not support symlinks + run: | + rm nodeapp/static + cp -r frontend/static nodeapp/static + - name: 'Download main.js Artifact' uses: dawidd6/action-download-artifact@v2 with: workflow: frontend-build.yml workflow_conclusion: success name: main-js - path: frontend/static/frontend/ + path: nodeapp/static/frontend/ - name: 'Log in to Docker Hub' uses: docker/login-action@v2 @@ -52,10 +57,6 @@ jobs: id: commit uses: pr-mpt/actions-commit-hash@v1 - - name: 'Save Commit Long Hash to TXT File' - run: | - echo ${{ steps.commit.outputs.long }}>"commit_sha.txt" - - name: 'Set up QEMU' uses: docker/setup-qemu-action@v2 diff --git a/nodeapp/README.md b/nodeapp/README.md index 301284c6..d180e9c9 100644 --- a/nodeapp/README.md +++ b/nodeapp/README.md @@ -4,4 +4,18 @@ RoboSats app for soverign nodes ( Umbrel, Citadel, Start9 ...). This app serves At the moment it has no special integration with your local lightning wallet (e.g. LND). This can be achieved easily by installing a WebLN compatible extension in your browser (e.g. getAlby). -The container launches two processes: 1) A `socat` that will expose RoboSats coordinator API over HTTP using the docker orchestration Tor socks proxy and 2) a `http-server` that will serve all static files (including the Javascript client app) directly from your own node (should reduce loading times by a lot). Every request that cannot be served by your node http-server will be forwarded to the RoboSats coordinator (that is: API calls and Robot avatar images). +# How it works + +The container launches two processes: 1) A `socat` that will expose RoboSats coordinator API over HTTP on localhost:81 using the docker orchestration TOR socks proxy and 2) a `http-server` that serves all static files (including the Javascript client app) directly from your own node (should reduce loading times by a lot). Every request that cannot be served by your node http-server will be forwarded to the RoboSats coordinator (that is: API calls and Robot avatar images). + +# Why host your own RoboSats client + +Advantages over a full over-the-internet RoboSats experience: +1. Dramatically faster load times. +2. Safer: you control what RoboSats client app you run. +3. Access RoboSats safely from any browser / device. No need to use TOR if you are on your local network or using VPN: your node backend handles the torification needed for anonymization. +4. Allows control over what P2P market coordinator you connect to (defaults to robosats6tkf3eva7x2voqso3a5wcorsnw34jveyxfqi2fu7oyheasid.onion) + +# Future upgrades + +1. Increase availability by procesing API requests via I2P when TOR is not available. \ No newline at end of file