Initial commit
This commit is contained in:
62
docs/operations.md
Normal file
62
docs/operations.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Operations
|
||||
|
||||
## Dry Run First
|
||||
|
||||
Keep this in `.env` until destination paths look correct:
|
||||
|
||||
```bash
|
||||
SORTARR_DRY_RUN=true
|
||||
```
|
||||
|
||||
Then switch to:
|
||||
|
||||
```bash
|
||||
SORTARR_DRY_RUN=false
|
||||
```
|
||||
|
||||
Restart:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Logs
|
||||
|
||||
Backend logs are written to `/logs/sortarr.log` in the container and to the host path configured by `LOGS_PATH`.
|
||||
|
||||
## Backups
|
||||
|
||||
Back up:
|
||||
|
||||
- `.env`
|
||||
- `config/`
|
||||
- `data/state.json`
|
||||
- `logs/` if you need historical audit trails
|
||||
|
||||
Media files are not stored inside containers.
|
||||
|
||||
## Updating
|
||||
|
||||
Because all source is mounted or copied from this project, update by editing files and rebuilding:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
## Transcoding
|
||||
|
||||
The backend image includes `ffmpeg`. The dashboard Tools page can build a queue from the cached library index and run the next conversion. Keep dry-run enabled while checking output paths; actual transcoding only runs when `SORTARR_DRY_RUN=false` or dry-run is disabled from the runtime Settings page.
|
||||
|
||||
## Track Editing
|
||||
|
||||
The Library detail panel can inspect a selected file with `ffprobe` and remux embedded audio/subtitle streams to set defaults or remove tracks. Dry-run mode returns the planned `ffmpeg` command only. Disable dry-run only after confirming the command and keep media backups for any bulk edits.
|
||||
|
||||
## Cache
|
||||
|
||||
Reusable metadata and ffprobe results are cached under `/data/cache`. The default cap is 20GB and pruning removes oldest cache files first.
|
||||
|
||||
## Recovery
|
||||
|
||||
Sortarr moves through a temporary `.sorting` file before final placement. If a container stops mid-move, check the destination folder for `*.sorting` files and compare against `/downloads`.
|
||||
|
||||
The app intentionally avoids deleting source folders and does not run destructive cleanup by default.
|
||||
Reference in New Issue
Block a user