RanchiMall/fcoin
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #514 from pinheadmz/walletdocs

Browse Source 
docs: wallet.conf details
This commit is contained in:
Javed Khan 2018-08-06 22:54:11 +05:30 committed by GitHub
commit ddeb73a396
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/Configuration.md
View File

@ -1,4 +1,10 @@
By default, the mainnet bcoin config file will reside in ~/.bcoin/bcoin.conf. 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.
For example:
Running `bcoin --network=regtest --api-key=menace --daemon` will read the config file at `~/.bcoin/regtest/bcoin.conf`
and ignore any `network` or `api-key` parameters listed in that file.
All bcoin configuration options work in the config file, CLI arguments, and All bcoin configuration options work in the config file, CLI arguments, and
process environment (with a `BCOIN_` prefix). process environment (with a `BCOIN_` prefix).
@ -80,19 +86,50 @@ Note that certain chain options affect the format and indexing of the chain data
## HTTP ## HTTP
- `http-host`: HTTP host to listen on (default: 127.0.0.1). - `http-host`: HTTP host to listen on (default: 127.0.0.1).
- `http-port`: HTTP port to listen on (default: 8332). - `http-port`: HTTP port to listen on (default: 8332 for mainnet).
- `ssl-cert`: Path to SSL cert. - `ssl-cert`: Path to SSL cert.
- `ssl-key`: Path to SSL key. - `ssl-key`: Path to SSL key.
- `service-key`: Service key (used for accessing wallet system only). - `service-key`: Service key (used for accessing wallet system only).
- `api-key`: API key (used for accessing all node APIs). - `api-key`: API key (used for accessing all node APIs, may be different than API key for wallet server).
- `wallet-auth`: Enable token auth for wallets (default: false).
- `no-auth`: Disable auth for API server and wallets (default: false).
- `cors`: Enable "Cross-Origin Resource Sharing" HTTP headers (default: false). - `cors`: Enable "Cross-Origin Resource Sharing" HTTP headers (default: false).
Note: For security `cors` should not be used with `no-auth`.\ Note: For security `cors` should not be used with `no-auth`.\
If enabled you should also enable `wallet-auth` and set `api-key`. If enabled you should also enable `wallet-auth` and set `api-key`.
## Sample Config File ## Wallet options
These options must be saved in `wallet.conf`:
### bcoin client:
- `node-host`: Location of bcoin node HTTP server (default: localhost).
- `node-port`: Port of bcoin node HTTP server (defaults to RPC port of network).
- `node-ssl`: Whether to use SSL (default: false).
- `node-api-key`: API-key for bcoin HTTP server.
### Wallet database:
- `memory`: Keep database in memory rather than write to disk.
- `max-files`: Max open files for leveldb.
- `cache-size`: Size (in MB) of leveldb cache and write buffer.
- `witness`: Make SegWit enabled wallets.
- `checkpoints`: Trust hard-coded blockchain checkpoints.
### Wallet http server:
- `ssl`: Whether to use SSL (default: false).
- `ssl-key`: Path to SSL key.
- `ssl-cert`: Path to SSL cert.
- `http-host`: HTTP host to listen on (default: 127.0.0.1).
- `http-port`: HTTP port to listen on (default: 8334 for mainnet).
- `api-key`: API key (used for accessing all wallet APIs, may be different than API key for node server).
- `cors`: Enable "Cross-Origin Resource Sharing" HTTP headers (default: false).
- `no-auth`: Disable auth for API server and wallets (default: false).
- `wallet-auth`: Enable token auth for wallets (default: false).
- `admin-token`: Token required if `wallet-auth` is enabled: restricts access to [all wallet admin routes.](http://bcoin.io/api-docs/#wallet-admin-commands)
## Sample Config Files
See https://github.com/bcoin-org/bcoin/blob/master/etc/sample.conf See https://github.com/bcoin-org/bcoin/blob/master/etc/sample.conf
and https://github.com/bcoin-org/bcoin/blob/master/etc/sample.wallet.conf and https://github.com/bcoin-org/bcoin/blob/master/etc/sample.wallet.conf