aiolabs/lightning-pub
2
0
Fork 0
Code Issues 9 Pull requests 4 Projects Releases Packages Wiki Activity Actions

Merge pull request #419 from shocknet/docs/docker-volume

Browse source 
Add volumes to Docker README
This commit is contained in:
CapDog 2021-07-12 11:09:23 -04:00 • committed by GitHub
commit 1910cb336d
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -57,14 +57,19 @@ yarn install
To run ShockAPI in a fully isolated environment you can use the Docker image 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. 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: Example of listing available configuration flags:
``` ```
docker run --rm shockwallet/api:latest --help 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
``` ```
<!--- <!---
### Docker for Raspberry Pi ### Docker for Raspberry Pi