From 93d5df559dc5ab8ea37e9304abcc77e437f2ecbf Mon Sep 17 00:00:00 2001 From: windsok Date: Fri, 2 Feb 2018 21:59:27 -0800 Subject: [PATCH] add docs about configuration file --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a8bbdfb0c..366727eee 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,24 @@ cli/lightning-cli pay Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use. +## Configuration File +lightningd can be configured either by passing options via the command line, or via a configuration file. Command line options will always override the values in the configuration file. + +To use a configuration file, create a file named "config" within your ".lightning" directory. Usually this will be ~/.lightning/config + +Configuration options are set using a key=value pair on each line of the file, for example: +``` +alias=SLEEPYDRAGON +rgb=008000 +port=9735 +network=testnet +``` + +For a full list of possible lightningd configuration options, run: +``` +lightningd/lightningd --help +``` + ## Further information JSON-RPC interface is documented in the following manual pages: