Merge pull request #437 from BluSyn/conf-cors

Docs: Update sample conf w/ wallet.conf + http cors option
This commit is contained in:
Steven Bower 2018-04-03 10:31:32 -07:00 committed by GitHub
commit 11630e9134
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 9 deletions

View File

@ -92,7 +92,12 @@ Note that certain chain options affect the format and indexing of the chain data
- `api-key`: API key (used for accessing all node APIs).
- `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).
Note: For security `cors` should not be used with `no-auth`.\
If enabled you should also enable `wallet-auth` and set `api-key`.
## Sample Config File
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

View File

@ -113,11 +113,4 @@ http-host: ::
# ssl-key: @/ssl/priv.key
api-key: bikeshed
# no-auth: false
#
# Wallet
#
wallet-witness: false
wallet-checkpoints: true
wallet-auth: false
# cors: false

28
etc/sample.wallet.conf Normal file
View File

@ -0,0 +1,28 @@
# Sample bcoin wallet config file (~/.bcoin/wallet.conf)
#
# Options
#
# network: main
#
# HTTP
#
http-host: ::
# http-port: 8334
# ssl: true
# ssl-cert: @/ssl/cert.crt
# ssl-key: @/ssl/priv.key
api-key: bikeshed
# no-auth: false
# cors: false
#
# Wallet
#
witness: false
checkpoints: true
wallet-auth: false