LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

grammar/spelling/updates

Browse source
This commit is contained in:
Thomas Zarebczan 2018-08-24 15:06:57 -04:00 committed by GitHub
parent 122afc4168
commit f05a07a32e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
documents/resources/daemon-settings.md
View file

@ -1,10 +1,10 @@
# Configurable settings for the LBRY daemon # Configurable settings for the LBRY daemon
This document outlines how to configure daemon settings and what options are available. They can be found on the lbry GitHub reposition in [conf.py](https://github.com/lbryio/lbry/blob/master/lbrynet/conf.py). This document outlines how to configure daemon settings and what options are available. They can be found on the lbry GitHub repository in [conf.py](https://github.com/lbryio/lbry/blob/master/lbrynet/conf.py).
## Daemon settings configuration ## Daemon settings configuration
The easiest way to configure the settings is via the `daemon_settings.yml` in the default [lbrynet directory](https://lbry.io/faq/lbry-directories). These settings will also be made available (currently only a few are) via the [settings_set](https://lbry.tech/api/protocol#settings_set). The easiest way to configure the settings is by editing the `daemon_settings.yml` file (may need to be created) that resides in the default [lbrynet directory](https://lbry.io/faq/lbry-directories). These settings can also be configured via the [settings_set](https://lbry.tech/api/protocol#settings_set) API call. The [settings_get](https://lbry.tech/api/protocol#settings_get) API call can be used to retrieve current values. Currently not all settings are made available via the API calls, see [GitHub issue 1374](https://github.com/lbryio/lbry/issues/1374).
Sample daemon_settings.yml file: Sample daemon_settings.yml file:
``` ```
@ -15,7 +15,7 @@ use_upnp: false
``` ```
## Configuration options ## Configuration options
Cofiguration options are separted by their respective areas: Files, Wallet, Network, Security and Other. Configuration options are organized by their respective areas: Files, Wallet, Network, Security and Other.
### Files ### Files
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
@ -28,13 +28,13 @@ Cofiguration options are separted by their respective areas: Files, Wallet, Netw
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
|-------------------------------|---------|------------------------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------| |-------------------------------|---------|------------------------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------|
| auto_renew_claim_height_delta | integer | 0 | 1000 | If your claim is X blocks away, auto renew it. | | auto_renew_claim_height_delta | integer | 0 | 1000 | If your claim is X blocks away, auto renew it. |
| blockchain_name | string | 'lbrycrd_main' | 'lbrycrd_regtest' | Blockchain network to connect to |
| disable_max_key_fee | boolean | FALSE | TRUE | If disabled, don't check for max fee |
| lbryum_servers | list | ['lbryumx1.lbry.io:50001','lbryumx2.lbry.io:50001'] | ["mylbryum.lbry.io:50001] | SPV wallet server address |
| lbryum_wallet_dir | string | [varies by OS](https://lbry.io/faq/lbry-directories) | 'c:\lbry\lbryum\' | Wallet data location | | lbryum_wallet_dir | string | [varies by OS](https://lbry.io/faq/lbry-directories) | 'c:\lbry\lbryum\' | Wallet data location |
| max_key_fee | json | {'currency': 'USD', 'amount': 50.0} | {'currency': 'LBC', 'amount': 5.0} | Max payment allowed for content | | max_key_fee | json | {'currency': 'USD', 'amount': 50.0} | {'currency': 'LBC', 'amount': 5.0} | Max payment allowed for content |
| disable_max_key_fee | boolean | FALSE | TRUE | If disabled, don't check for max fee |
| use_keyring | boolean | FALSE | TRUE | Store wallet password in keyring |
| wallet | string | 'lbryum' | 'lbrycrd' | Choice of wallet software, SPV (lbryum) vs full node (lbrycrd). Currently only lbryum supported | | wallet | string | 'lbryum' | 'lbrycrd' | Choice of wallet software, SPV (lbryum) vs full node (lbrycrd). Currently only lbryum supported |
| blockchain_name | string | 'lbrycrd_main' | 'lbrycrd_regtest' | Blockchain network to connect to | | use_keyring | boolean | FALSE | TRUE | Store wallet password in keyring |
| lbryum_servers | list | ['lbryumx1.lbry.io:50001','lbryumx2.lbry.io:50001'] | ["mylbryum.lbry.io:50001] | SPV wallet address |
### Network ### Network
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
@ -42,7 +42,7 @@ Cofiguration options are separted by their respective areas: Files, Wallet, Netw
| api_host | string | localhost | 0.0.0.0 | IP address the daemon API will listen on | | api_host | string | localhost | 0.0.0.0 | IP address the daemon API will listen on |
| api_port | integer | 5279 | 9000 | Port the daemon API will listen on | | api_port | integer | 5279 | 9000 | Port the daemon API will listen on |
| cache_time | integer | 150 | 90 | How long to keep resolve data in cache | | cache_time | integer | 150 | 90 | How long to keep resolve data in cache |
| data_rate | float | 0.0001 | 0.05 | What LBC rate, per MB, to offer DHT data at (currently disabled in the protocol) | | data_rate | float | 0.0001 | 0.05 | What LBC rate, per MB, to offer DHT data at (currently disabled in the protocol) |
| dht_node_port | integer | 4444 | 4445 | UDP port used to announce blobs | | dht_node_port | integer | 4444 | 4445 | UDP port used to announce blobs |
| download_timeout | integer | 180 | 30 | Time, in seconds, to allow download to get data blobs | | download_timeout | integer | 180 | 30 | Time, in seconds, to allow download to get data blobs |
| download_mirrors | list | ['blobs.lbry.io'] | 0 or [myreflector.lbry.io] | Location of mirrored content | | download_mirrors | list | ['blobs.lbry.io'] | 0 or [myreflector.lbry.io] | Location of mirrored content |
@ -59,7 +59,7 @@ Cofiguration options are separted by their respective areas: Files, Wallet, Netw
| reflector_servers | list | ['reflector.lbry.io'] | ['myreflector.lbry.io'] | Server data will be reflected to | | reflector_servers | list | ['reflector.lbry.io'] | ['myreflector.lbry.io'] | Server data will be reflected to |
| run_reflector_server | boolean | FALSE | TRUE | Daemon will act as a reflector node - accept data from other nodes | | run_reflector_server | boolean | FALSE | TRUE | Daemon will act as a reflector node - accept data from other nodes |
| sd_download_timeout | integer | 3 | 1 | Time, in mintues, to allow download to get sd blob | | sd_download_timeout | integer | 3 | 1 | Time, in mintues, to allow download to get sd blob |
| peer_search_timeout | integer | 60 | 30 | Time, in seconds, to allow download to find peers | | peer_search_timeout | integer | 60 | 30 | Time, in seconds, to allow download to find peers |
| use_upnp | boolean | TRUE | FALSE | Attempt external port mapping via UPnP | | use_upnp | boolean | TRUE | FALSE | Attempt external port mapping via UPnP |
### Security ### Security
@ -67,10 +67,10 @@ Cofiguration options are separted by their respective areas: Files, Wallet, Netw
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
|----------------|---------|---------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------| |----------------|---------|---------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------|
| allowed_origin | string | '' | '*' or localhost | IP address to allow API requests from | | allowed_origin | string | '' | '*' or localhost | IP address to allow API requests from |
| use_auth_http | boolean | FALSE | TRUE | See [authentication instructions](https://github.com/lbryio/lbry/blob/master/lbrynet/daemon/auth/server.py#L179) for details | | use_auth_http | boolean | FALSE | TRUE | See [authentication instructions](https://github.com/lbryio/lbry/blob/master/lbrynet/daemon/auth/server.py#L179) for details |
### Other ### Other
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
|--------------------|---------|---------------|--------------------------------|---------------------------------------------------------------------------------------------------------------| |--------------------|---------|---------------|--------------------------------|---------------------------------------------------------------------------------------------------------------|
| components_to_skip | list | [] | ['reflector','hash_announcer'] | Disabe components, [see entire list here](https://github.com/lbryio/lbry/wiki/Component-Dependencies-Table) |
| share_usage_data | boolean | TRUE | FALSE | Share analytics data | | share_usage_data | boolean | TRUE | FALSE | Share analytics data |
| components_to_skip | list | [] | ['reflector','hash_announcer'] | Disabe components, [see entire list here](https://github.com/lbryio/lbry/wiki/Component-Dependencies-Table) |