diff --git a/.env.example b/.env.example index f5199e6b..710cb02f 100644 --- a/.env.example +++ b/.env.example @@ -16,3 +16,5 @@ LOCAL_TUNNEL_SERVER=https://tunnel.rip TORRENT_SEED_URL=https://webtorrent.shock.network # Admin token for your own seed server TORRENT_SEED_TOKEN=jibberish +# "default" or "hosting" +DEPLOYMENT_TYPE=hosting \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 2faaa640..f7a45822 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,9 +4,5 @@ "debug.node.autoAttach": "on", "editor.formatOnSave": true, "editor.defaultFormatter": "esbenp.prettier-vscode", - "cSpell.words": [ - "Epub", - "ISEA", - "Reqs" - ] + "cSpell.words": ["Epub", "GUNRPC", "ISEA", "PUBKEY", "Reqs", "uuidv"] } diff --git a/README.md b/README.md index d4206e57..0df88fbc 100644 --- a/README.md +++ b/README.md @@ -57,14 +57,19 @@ yarn install To run ShockAPI in a fully isolated environment you can use the Docker image provided on the Docker Hub and easily interact with API's CLI interface and flags. +#### Prerequisites +To interact with ShockAPI's Docker image you need an instance of LND running and +also if your configs, LND related files and certificates are located on a local file system you'll need to mount **Docker Volumes** pointed to them while starting the container. + Example of listing available configuration flags: ``` docker run --rm shockwallet/api:latest --help ``` -Example of running an local instance: +Example of running an local instance with mounted volumes: ``` -docker run shockwallet/api:latest -h 0.0.0.0 -c +docker run -v /home/$USER/.lnd:/root/.lnd --network host shockwallet/api:latest ``` +