Created SDK Disk Space Management Settings (markdown)

Victor Shyba 2021-10-26 23:38:26 -03:00
parent 7a47761232
commit b237fc1092

@ -0,0 +1,27 @@
There are currently two configuration options for setting up disk space management on the SDK currently. This small guide should help clarifying what they mean.
For using them, just set [using the settings_set api](https://lbry.tech/api/sdk#settings_set) or `daemon_settings.yaml` file.
## Relevant configuration keys
### network_storage_limit
Default: 0
Disk space in megabytes to be allocated for helping the P2P network with background downloads and seeding. The way it works is explained in a section below.
Setting it to 0 disables background downloading.
### blob_storage_limit
Default: 0
Disk space in megabytes to be allocated for downloads and streams during normal usage of the SDK.
Setting it to 0 disables disk space management for files (or make it unlimited in other words).
## What happens when the limit is reached?
There are plans for better space management policies, but for now we delete the oldest data. When that changes, this section will be updated.
## What does helping the P2P network means?
When you allocate space for helping the P2P network, your SDK instance will listen for DHT requests and re-host content as they are being requested, until the allocated space is full. Then it will announce and keep serving that content to other peers.
This data won't pollute your library, show up in file list or require manual intervention. Everything happens automatically.
Seeding also happens naturally to normal files, this won't replace or disable previous behavior.