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

daemon settings update for 0.31+

Browse source
This commit is contained in:
Thomas Zarebczan 2019-03-08 01:22:12 -05:00 committed by GitHub
parent a84e38d278
commit 4812770834
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -7,16 +7,18 @@ This document outlines how to configure SDK daemon settings and what options are
## Daemon settings configuration ## Daemon settings configuration
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/sdk#settings_set) API call. The [settings_get](https://lbry.tech/api/sdk#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). 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/sdk#settings_set) API call. The [settings_get](https://lbry.tech/api/sdk#settings_get) API call can be used to retrieve current values. Some values will require an SDK restart after being set via the API call.
Sample daemon_settings.yml file: Sample daemon_settings.yml file:
``` ```
peer_port: 3335 tcp_port: 3335
lbryum_servers: ['lbryumx1.lbry.io:50001','lbryumx2.lbry.io:50001'] lbryum_servers: ['lbryumx1.lbry.io:50001','lbryumx2.lbry.io:50001']
download_directory: 'c:\lbry\Downloads' download_directory: 'c:\lbry\Downloads'
use_upnp: false use_upnp: false
``` ```
To run the SDK with a specific configuration file, launch it by passing the config path: ```lbrynet start --config=c:\path\to\conf\daemon_settings.yml```. To run in debug mode, start with ```lbrynet start --verbose=lbrynet```.
## Configuration options ## Configuration options
Configuration options are organized by their respective areas: Files, Wallet, Network, Security and Other. Configuration options are organized by their respective areas: Files, Wallet, Network, Security and Other.
@ -25,44 +27,39 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
|------------------------|---------|------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------| |------------------------|---------|------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------|
| data_dir | string | [varies by OS](https://lbry.io/faq/lbry-directories) | 'c:\lbry\lbrynet\' | Where to store the lbrynet folder, which includes blob files, logs and config data | | data_dir | string | [varies by OS](https://lbry.io/faq/lbry-directories) | 'c:\lbry\lbrynet\' | Where to store the lbrynet folder, which includes blob files, logs and config data |
| delete_blobs_on_remove | boolean | true | false | Delete blobs on a file_delete call? | | delete_blobs_on_remove | boolean | true | false | Delete blobs on a file_delete call? |
| download_directory | string | local downloads folder | 'c:\lbry\lbrynet\' | Location of downloaded output files | | download_dir | string | local downloads folder | 'c:\lbry\lbrynet\' | Location of downloaded output files |
### Wallet ### Wallet
| 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. 0 means disabled (default) |
| blockchain_name | string | 'lbrycrd_main' | 'lbrycrd_regtest' | Blockchain network to connect to | | 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_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 | | 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 |
| 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 |
| use_keyring | boolean | false | true | Store wallet password in keyring | | use_keyring | boolean | false | true | Store wallet password in keyring (not currently available) |
### Network ### Network
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
|----------------------------|---------|---------------------------|----------------------------|------------------------------------------------------------------------------------| |----------------------------|---------|---------------------------|----------------------------|------------------------------------------------------------------------------------|
| api_host | string | localhost | 0.0.0.0 | IP address the daemon API will listen on | | api | string | localhost:5279 | 0:0:0:0:5280 | IP address and port the SDK 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 | | udp_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 | 30 | 60 | 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. 0 means disabled. |
| is_generous_host | boolean | true | false | Host blobs without data payments |
| announce_head_blobs_only | boolean | true | false | Only announce first data blob | | announce_head_blobs_only | boolean | true | false | Only announce first data blob |
| concurrent_announcers | integer | 10 | 0 | Threads used in order to announce blobs. 0 means disabled | | concurrent_blob_announcers | integer | 10 | 0 | Threads used in order to announce blobs. 0 means disabled |
| known_dht_nodes | list | ['lbrynet1.lbry.io:4444'] | ['myDHT.lbry.io:4444'] | Bootstrap nodes for network connectivity | | known_dht_nodes | list | ['lbrynet1.lbry.io:4444'] | ['myDHT.lbry.io:4444'] | Bootstrap nodes for network connectivity |
| max_connections_per_stream | integer | 5 | 10 | Threads used to download blobs | | max_connections_per_stream | integer | 5 | 10 | Threads used to download blobs |
| seek_head_blob_first | boolean | true | false | Search for first data blob after downloading sd blob | | seek_head_blob_first | boolean | true | false | Search for first data blob after downloading sd blob |
| peer_port | integer | 3333 | 3334 | Port the daemon will listen on | | tcp_port | integer | 3333 | 3334 | Port the SDK will listen on |
| reflector_port | integer | 5566 | 5555 | Reflector port to listen on | | concurrent-reflector-uploads| integer | 5 | 10 | Connections to use while uploading data to reflector |
| reflect_uploads | boolean | true | false | Send published data to reflector servers | | reflect_streams | boolean | true | false | Send published data to reflector servers |
| auto_re_reflect_interval | integer | 86400 (1 day) | 43200 | Time in seconds to re-check reflected data |
| 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 | | fixed-peer-delay | integer | 2 | 5 | Time, in mintues, to allow download from P2P before trying fixed peer |
| sd_download_timeout | integer | 3 | 1 | Time, in mintues, to allow download to get sd blob | | peer_connect_timeout | integer | 30 | 15 | Time, in seconds, to allow download to find peers |
| peer_search_timeout | integer | 60 | 30 | Time, in seconds, to allow download to find peers | | node_rpc_timeout | integer | 5 | 10 | Time, in seconds, to allow connection over DHT |
| network_interface | string | 0:0:0:0 | 127.0.0.1 | Interface to use for the DHT and blob exchange |
| use_upnp | boolean | true | false | Attempt external port mapping via UPnP | | use_upnp | boolean | true | false | Attempt external port mapping via UPnP |
### Security ### Security
@ -75,5 +72,5 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
### Other ### Other
| Setting | Format | Default value | Sample Values | Description | | Setting | Format | Default value | Sample Values | Description |
|--------------------|---------|---------------|--------------------------------|---------------------------------------------------------------------------------------------------------------| |--------------------|---------|---------------|--------------------------------|---------------------------------------------------------------------------------------------------------------|
| components_to_skip | list | [] | ['reflector','hash_announcer'] | Disable components, [see entire list here](https://github.com/lbryio/lbry/wiki/Component-Dependencies-Table) | | components_to_skip | list | [] | ['reflector','hash_announcer'] | Disable 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 |