From f4db94b2546e57cc365bfe8c0560f28dcb6d5456 Mon Sep 17 00:00:00 2001 From: Erfan Besharat Date: Mon, 12 Jul 2021 19:33:29 +0430 Subject: [PATCH] Add volumes to Docker README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) 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 ``` +