102 lines
2.4 KiB
Markdown
102 lines
2.4 KiB
Markdown
# Configuration Reference
|
|
|
|
This document describes all supported options in `config.toml`.
|
|
|
|
## Locations
|
|
- Config: `$XDG_CONFIG_HOME/mov-renamarr/config.toml` (fallback `~/.config/mov-renamarr/config.toml`)
|
|
- Cache: `$XDG_CACHE_HOME/mov-renamarr/cache.db` (fallback `~/.cache/mov-renamarr/cache.db`)
|
|
|
|
The app creates a commented default config on first run if none exists.
|
|
|
|
## Precedence
|
|
1) Built-in defaults
|
|
2) Config file
|
|
3) Environment variables
|
|
4) CLI flags
|
|
|
|
## Minimal example
|
|
```toml
|
|
provider = "auto"
|
|
api_key_tmdb = "YOUR_TMDB_KEY_OR_READ_ACCESS_TOKEN"
|
|
quality_tags = ["resolution"]
|
|
|
|
[llm]
|
|
mode = "off"
|
|
```
|
|
|
|
## Providers
|
|
```toml
|
|
provider = "auto" # auto|tmdb|omdb|both
|
|
api_key_tmdb = "..." # TMDb API key or Read Access Token (Bearer)
|
|
api_key_omdb = "..." # OMDb API key
|
|
```
|
|
|
|
## Cache
|
|
```toml
|
|
cache_path = "/home/user/.cache/mov-renamarr/cache.db"
|
|
cache_ttl_days = 30
|
|
refresh_cache = false
|
|
```
|
|
|
|
## Reporting and sidecars
|
|
```toml
|
|
report_format = "text" # text|json|csv
|
|
sidecar_notes = false # write per-file notes for skipped/failed
|
|
sidecars = false # move/copy sidecar files (srt, nfo, etc)
|
|
```
|
|
|
|
## Matching and naming
|
|
```toml
|
|
min_score = 80 # 0-100 match threshold
|
|
include_id = false # include tmdb/imdb id in filenames
|
|
no_lookup = false # skip external providers (filename/LLM only)
|
|
```
|
|
|
|
## Quality tags
|
|
```toml
|
|
quality_tags = ["resolution"] # list
|
|
# or
|
|
quality_tags = "resolution,codec" # comma-separated string
|
|
```
|
|
Supported tags: `resolution`, `codec`, `source`, `all`, `none`.
|
|
|
|
## Output safety
|
|
```toml
|
|
overwrite = false # replace existing files
|
|
suffix = false # add " (1)", " (2)" on collision
|
|
```
|
|
|
|
## Console
|
|
```toml
|
|
color = "auto" # auto|always|never
|
|
```
|
|
|
|
## Concurrency
|
|
```toml
|
|
jobs = "auto" # auto or integer
|
|
net_jobs = "auto" # auto or integer
|
|
```
|
|
|
|
## LLM (Ollama)
|
|
```toml
|
|
[llm]
|
|
mode = "off" # off|parse|assist
|
|
endpoint = "http://localhost:11434"
|
|
model = "Qwen2.5:latest"
|
|
timeout_seconds = 30
|
|
max_tokens = 256
|
|
```
|
|
Recommended models:
|
|
- `Qwen2.5:latest` (safe default)
|
|
- `Qwen2.5:14b` (higher accuracy, more RAM/VRAM)
|
|
|
|
## Provider base URLs (for testing)
|
|
```toml
|
|
tmdb_base_url = "https://api.themoviedb.org/3"
|
|
omdb_base_url = "https://www.omdbapi.com"
|
|
```
|
|
|
|
## Environment variables
|
|
All config settings can be overridden with environment variables using the
|
|
`MOV_RENAMARR_` prefix (e.g., `MOV_RENAMARR_TMDB_API_KEY`).
|