mirror of
https://github.com/xpltdco/media-rip.git
synced 2026-04-03 02:53:58 -06:00
Clean up docs: fix config defaults, remove redundant vars, add missing ones
README Configuration section: - Organized into logical groups (Core, Admin, Purge, UI, yt-dlp) - Fixed wrong defaults: admin.enabled (true not false), purge.enabled (true not false), purge field is max_age_minutes not max_age_hours, purge.cron is '* * * * *' not '0 3 * * *' - Removed redundant internal-path vars (DB_PATH, DATA_DIR, OUTPUT_DIR) that are pre-set in the Dockerfile and shouldn't be changed - Added missing vars: LOG_LEVEL, UI settings, PRIVACY_MODE, YTDLP - Added extractor_args usage examples (YAML and env var) docker-compose files: - Switched healthcheck from python urllib to curl (already in image) - Removed stale PURGE__MAX_AGE_HOURS references - Added commented yt-dlp extractor_args example - Simplified comments to reflect actual defaults
This commit is contained in:
xpltd
parent
f3d1f29ca1
commit
61ee8d4eff
3 changed files with 62 additions and 22 deletions
64
README.md
64
README.md
|
|
@ -42,24 +42,66 @@ Downloads are saved to `./downloads/`.
|
|||
|
||||
## Configuration
|
||||
|
||||
All settings have sensible defaults. Override via environment variables or `config.yaml`:
|
||||
All settings have sensible defaults — zero config required. Override via environment variables or mount a `config.yaml`:
|
||||
|
||||
### Core Settings
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `MEDIARIP__SERVER__PORT` | `8000` | Internal server port |
|
||||
| `MEDIARIP__SERVER__DB_PATH` | `/data/mediarip.db` | SQLite database path |
|
||||
| `MEDIARIP__SERVER__DATA_DIR` | `/data` | Persistent data directory |
|
||||
| `MEDIARIP__DOWNLOADS__OUTPUT_DIR` | `/downloads` | Where files are saved |
|
||||
| `MEDIARIP__SERVER__LOG_LEVEL` | `info` | Log level (`debug`, `info`, `warning`, `error`) |
|
||||
| `MEDIARIP__DOWNLOADS__MAX_CONCURRENT` | `3` | Maximum parallel downloads |
|
||||
| `MEDIARIP__SESSION__MODE` | `isolated` | `isolated`, `shared`, or `open` |
|
||||
| `MEDIARIP__SESSION__TIMEOUT_HOURS` | `72` | Session cookie lifetime |
|
||||
| `MEDIARIP__ADMIN__ENABLED` | `false` | Enable admin panel |
|
||||
| `MEDIARIP__SESSION__TIMEOUT_HOURS` | `72` | Session cookie lifetime (hours) |
|
||||
|
||||
### Admin Panel
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `MEDIARIP__ADMIN__ENABLED` | `true` | Enable admin panel |
|
||||
| `MEDIARIP__ADMIN__USERNAME` | `admin` | Admin username |
|
||||
| `MEDIARIP__ADMIN__PASSWORD_HASH` | _(empty)_ | Bcrypt hash of admin password |
|
||||
| `MEDIARIP__PURGE__ENABLED` | `false` | Enable auto-purge of old downloads |
|
||||
| `MEDIARIP__PURGE__MAX_AGE_HOURS` | `168` | Delete downloads older than this |
|
||||
| `MEDIARIP__PURGE__CRON` | `0 3 * * *` | Purge schedule (cron syntax) |
|
||||
| `MEDIARIP__THEMES_DIR` | `/themes` | Custom themes directory |
|
||||
|
||||
### Auto-Purge
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `MEDIARIP__PURGE__ENABLED` | `true` | Enable automatic cleanup of old downloads |
|
||||
| `MEDIARIP__PURGE__MAX_AGE_MINUTES` | `1440` | Delete completed downloads older than this (minutes) |
|
||||
| `MEDIARIP__PURGE__CRON` | `* * * * *` | Purge check schedule (cron syntax) |
|
||||
| `MEDIARIP__PURGE__PRIVACY_MODE` | `false` | Aggressive cleanup — removes downloads + logs on schedule |
|
||||
| `MEDIARIP__PURGE__PRIVACY_RETENTION_MINUTES` | `1440` | Retention period when privacy mode is enabled |
|
||||
|
||||
### UI Customization
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `MEDIARIP__UI__DEFAULT_THEME` | `dark` | Default theme (`dark`, `light`, `cyberpunk`, or custom) |
|
||||
| `MEDIARIP__UI__WELCOME_MESSAGE` | _(built-in)_ | Header subtitle text shown to users |
|
||||
|
||||
### yt-dlp Tuning
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `MEDIARIP__YTDLP__EXTRACTOR_ARGS` | `{}` | JSON object of yt-dlp extractor args (see below) |
|
||||
|
||||
Use `extractor_args` to tune YouTube player client selection or pass arguments to any yt-dlp extractor:
|
||||
|
||||
```yaml
|
||||
# config.yaml
|
||||
ytdlp:
|
||||
extractor_args:
|
||||
youtube:
|
||||
player_client: ["web_safari", "android_vr"]
|
||||
```
|
||||
|
||||
Or via environment variable:
|
||||
|
||||
```bash
|
||||
MEDIARIP__YTDLP__EXTRACTOR_ARGS='{"youtube": {"player_client": ["web_safari"]}}'
|
||||
```
|
||||
|
||||
> **Note:** Internal paths (`SERVER__DB_PATH`, `SERVER__DATA_DIR`, `DOWNLOADS__OUTPUT_DIR`) are pre-configured in the Docker image. Only override these if you change the volume mount points.
|
||||
|
||||
### Session Modes
|
||||
|
||||
|
|
@ -69,7 +111,7 @@ All settings have sensible defaults. Override via environment variables or `conf
|
|||
|
||||
### Admin Panel
|
||||
|
||||
Enable the admin panel to manage sessions, view storage, trigger manual purge, and review error logs:
|
||||
The admin panel is enabled by default. On first run, you'll be prompted to set a password in the browser. Or pre-configure via environment:
|
||||
|
||||
```yaml
|
||||
# docker-compose.yml environment section
|
||||
|
|
|
|||
|
|
@ -28,13 +28,10 @@ services:
|
|||
MEDIARIP__ADMIN__PASSWORD_HASH: "${ADMIN_PASSWORD_HASH}"
|
||||
# Session mode: isolated (default), shared, or open
|
||||
MEDIARIP__SESSION__MODE: "${SESSION_MODE:-isolated}"
|
||||
# Auto-purge (optional)
|
||||
# MEDIARIP__PURGE__ENABLED: "true"
|
||||
# MEDIARIP__PURGE__MAX_AGE_HOURS: "168"
|
||||
expose:
|
||||
- "8000"
|
||||
healthcheck:
|
||||
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/api/health')"]
|
||||
test: ["CMD", "curl", "-f", "http://localhost:8000/api/health"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 3
|
||||
|
|
|
|||
|
|
@ -21,16 +21,17 @@ services:
|
|||
# - ./config.yaml:/app/config.yaml:ro # YAML config file
|
||||
environment:
|
||||
- MEDIARIP__SESSION__MODE=isolated
|
||||
# Admin panel (disabled by default):
|
||||
# - MEDIARIP__ADMIN__ENABLED=true
|
||||
# - MEDIARIP__ADMIN__USERNAME=admin
|
||||
# Admin panel (enabled by default — set password on first run in browser):
|
||||
# - MEDIARIP__ADMIN__PASSWORD_HASH=$2b$12$...your.bcrypt.hash...
|
||||
# Auto-purge (disabled by default):
|
||||
# - MEDIARIP__PURGE__ENABLED=true
|
||||
# - MEDIARIP__PURGE__MAX_AGE_HOURS=168
|
||||
#
|
||||
# Auto-purge (enabled by default — 24h retention):
|
||||
# - MEDIARIP__PURGE__MAX_AGE_MINUTES=1440
|
||||
#
|
||||
# yt-dlp tuning (optional):
|
||||
# - MEDIARIP__YTDLP__EXTRACTOR_ARGS={"youtube": {"player_client": ["web_safari"]}}
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/api/health')"]
|
||||
test: ["CMD", "curl", "-f", "http://localhost:8000/api/health"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 3
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue