Update Configuration File Options

2025-08-13 21:54:38 -05:00
parent e685c22971
commit 1d8d78ccab

@@ -4,29 +4,29 @@ This document describes configuration settings for **Repertory** across all prov
## 🛠 Common Settings (S3, Sia, Remote)
| Setting | Description | Live Update |
|---------|-------------|-------------|
| ApiUser | API username for authentication | ❌ |
| ApiPassword | API password for authentication | ❌ |
| ApiPort | API listening port | ❌ |
| DatabaseType | Storage backend type (e.g., rocksdb) | ❌ |
| DownloadTimeoutSeconds | Max time in seconds before a download is aborted | ✅ |
| EnableDownloadTimeout | Whether download timeout is enforced | ✅ |
| EnableDriveEvents | Enable event tracking for drive operations | ✅ |
| EventLevel | Logging verbosity (info, debug, etc.) | ✅ |
| EvictionDelayMinutes | Delay before cached files are evicted | ✅ |
| EvictionUseAccessedTime | Use last access time for eviction logic | ✅ |
| HighFreqIntervalSeconds | Interval for high-frequency tasks | ❌ |
| LowFreqIntervalSeconds | Interval for low-frequency tasks | ❌ |
| MedFreqIntervalSeconds | Interval for medium-frequency tasks | ❌ |
| MaxCacheSizeBytes | Maximum cache size in bytes | ✅ |
| MaxUploadCount | Max simultaneous uploads | ✅ |
| OnlineCheckRetrySeconds | Seconds between online check retries | ✅ |
| PreferredDownloadType | Download strategy (default, streaming, etc.) | ✅ |
| RetryReadCount | Number of read retries before failing | ✅ |
| RingBufferFileSize | Size of the ring buffer file in MB | ✅ |
| TaskWaitMs | Delay between queued tasks in ms | ✅ |
| Version | Config schema version | ✅ |
| Setting | Description | Providers | Live Update |
|---------|-------------|-----------|-------------|
| ApiUser | API username for authentication | ✅ Remote / ✅ S3 / ✅ Sia | ❌ |
| ApiPassword | API password for authentication | ✅ Remote / ✅ S3 / ✅ Sia | ❌ |
| ApiPort | API listening port | ✅ Remote / ✅ S3 / ✅ Sia | ❌ |
| DatabaseType | Storage backend type (e.g., rocksdb) | ✅ Remote / ✅ S3 / ✅ Sia | ❌ |
| DownloadTimeoutSeconds | Max time in seconds before a download is aborted | ✅ S3 / ✅ Sia | ✅ |
| EnableDownloadTimeout | Whether download timeout is enforced | ✅ S3 / ✅ Sia | ✅ |
| EnableDriveEvents | Enable event tracking for drive operations | ✅ Remote / ✅ S3 / ✅ Sia | ✅ |
| EventLevel | Logging verbosity (info, debug, etc.) | ✅ Remote / ✅ S3 / ✅ Sia | ✅ |
| EvictionDelayMinutes | Delay before cached files are evicted | ✅ S3 / ✅ Sia | ✅ |
| EvictionUseAccessedTime | Use last access time for eviction logic | ✅ S3 / ✅ Sia | ✅ |
| HighFreqIntervalSeconds | Interval for high-frequency tasks | ✅ S3 / ✅ Sia | ❌ |
| LowFreqIntervalSeconds | Interval for low-frequency tasks | ✅ S3 / ✅ Sia | ❌ |
| MedFreqIntervalSeconds | Interval for medium-frequency tasks | ✅ S3 / ✅ Sia | ❌ |
| MaxCacheSizeBytes | Maximum cache size in bytes | ✅ S3 / ✅ Sia | ✅ |
| MaxUploadCount | Max simultaneous uploads | ✅ S3 / ✅ Sia | ✅ |
| OnlineCheckRetrySeconds | Seconds between online check retries | ✅ S3 / ✅ Sia | ✅ |
| PreferredDownloadType | Download strategy (default, streaming, etc.) | ✅ S3 / ✅ Sia | ✅ |
| RetryReadCount | Number of read retries before failing | ✅ S3 / ✅ Sia | ✅ |
| RingBufferFileSize | Size of the ring buffer file in MB | ✅ S3 / ✅ Sia | ✅ |
| TaskWaitMs | Delay between queued tasks in ms | ✅ Remote / ✅ S3 / ✅ Sia | ✅ |
| Version | Config schema version | ✅ Remote / ✅ S3 / ✅ Sia | ✅ |
---