Browse Source

Add some more documentation

master
nolim1t 4 years ago
parent
commit
b328511784
No known key found for this signature in database GPG Key ID: F6287B82CC84BCBD
  1. 7
      README.md

7
README.md

@ -8,6 +8,10 @@
docker pull lncm/neutrino-switcher
```
## If using docker-compose
- Container name of LND needs to match the environment variable defined (if not lnd)
## Files/Folders it needs access to
You may map these anywhere in your filesystem
@ -15,10 +19,11 @@ You may map these anywhere in your filesystem
- /secrets/rpcpass.txt (Bitcoin RPC Password)
- /lnd/lnd.conf (LND configuration. For best results write access please)
- /statuses/ (Write access)
- /var/run/docker.sock (is mapped correctly so it can restart the container)
## Environment Variables
Other than that everything should be in the default paths.
- JSONRPCURL (Default: http://10.254.2.2:8332) : Is the JSON-RPC interface for bitcoind
- LND_CONTAINER_NAME (Default: lncm_lnd_1) : is the container name to restart
- LND_CONTAINER_NAME (Default: lnd) : is the container name to restart

Loading…
Cancel
Save