From 7178d9b2cd4a7c13572e81bccd17db88072e6b9e Mon Sep 17 00:00:00 2001 From: Matthew Zipkin Date: Wed, 22 Aug 2018 09:37:16 -0700 Subject: [PATCH] docs: describes `wallet-` prefix for CLI config (#584) Had a few support chats about connecting to a remote bcoin server from a local client. Indicating here how to launch bcoin with node and wallet configs in one line. Also users might not realize that you can run bclient on its own locally, and the config files are still in the same place as bcoin itself. --- docs/Configuration.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 567dd7fb2..70c409d36 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,5 +1,5 @@ By default, the mainnet bcoin config files will reside in `~/.bcoin/bcoin.conf` and `~/.bcoin/wallet.conf`. -Any parameter passed to bcoin at startup will have precedence over the config file. +Any parameter passed to bcoin at startup will have precedence over the config file. Even if you are just running `bclient` without bcoin even installed (to access a remote server, for example) the configuration files would still reside in `~/.bcoin/` For example: @@ -99,7 +99,12 @@ If enabled you should also enable `wallet-auth` and set `api-key`. ## Wallet options -These options must be saved in `wallet.conf`: +These options must be saved in `wallet.conf`. They can also be passed as environment variables or command-line variables +if they are preceeded with a `wallet-` prefix. (See https://github.com/bcoin-org/bcoin/blob/master/CHANGELOG.md#configuration-changes) + +For example, to run a bcoin and wallet node on a remote server that you can access from a local machine, you would launch bcoin with the command: + +`bcoin --network=testnet --http-host=0.0.0.0 --wallet-http-host=0.0.0.0 --wallet-api-key=hunter2 --wallet-wallet-auth=true` ### bcoin client: