|
| 1 | +# sonarr |
| 2 | + |
| 3 | +TV show collection manager for Usenet and BitTorrent users. |
| 4 | + |
| 5 | +## Environment Variables |
| 6 | + |
| 7 | +| Variable | Description | Default | |
| 8 | +|----------|-------------|---------| |
| 9 | +| `PUID` | User ID for the application process | `1000` | |
| 10 | +| `PGID` | Group ID for the application process | `1000` | |
| 11 | +| `TZ` | Timezone for the container | `UTC` | |
| 12 | +| `S6_LOG_ENABLE` | Enable/Disable file logging | `1` | |
| 13 | +| `S6_LOG_MAX_SIZE` | Max size per log file (bytes) | `1048576` | |
| 14 | +| `S6_LOG_MAX_FILES` | Number of rotated log files to keep | `10` | |
| 15 | + |
| 16 | +## Logging |
| 17 | + |
| 18 | +This image uses `s6-log` for internal log rotation. |
| 19 | +- **System Logs**: Captured from console and stored at `/config/logs/daemonless/sonarr/`. |
| 20 | +- **Application Logs**: Managed by the app and typically found in `/config/logs/`. |
| 21 | +- **Podman Logs**: Output is mirrored to the console, so `podman logs` still works. |
| 22 | + |
| 23 | +## Quick Start |
| 24 | + |
| 25 | +```bash |
| 26 | +podman run -d --name sonarr \ |
| 27 | + -p 8989:8989 \ |
| 28 | + --annotation 'org.freebsd.jail.allow.mlock=true' \ |
| 29 | + -e PUID=1000 -e PGID=1000 \ |
| 30 | + -v /path/to/config:/config \ |
| 31 | + -v /path/to/tv:/tv \ |
| 32 | + -v /path/to/downloads:/downloads \ |
| 33 | + ghcr.io/daemonless/sonarr:latest |
| 34 | +``` |
| 35 | + |
| 36 | +Access at: http://localhost:8989 |
| 37 | + |
| 38 | +## podman-compose |
| 39 | + |
| 40 | +```yaml |
| 41 | +services: |
| 42 | + sonarr: |
| 43 | + image: ghcr.io/daemonless/sonarr:latest |
| 44 | + container_name: sonarr |
| 45 | + environment: |
| 46 | + - PUID=1000 |
| 47 | + - PGID=1000 |
| 48 | + - TZ=America/New_York |
| 49 | + volumes: |
| 50 | + - /data/config/sonarr:/config |
| 51 | + - /data/media/tv:/tv |
| 52 | + - /data/downloads:/downloads |
| 53 | + ports: |
| 54 | + - 8989:8989 |
| 55 | + annotations: |
| 56 | + org.freebsd.jail.allow.mlock: "true" |
| 57 | + restart: unless-stopped |
| 58 | +``` |
| 59 | +
|
| 60 | +## Tags |
| 61 | +
|
| 62 | +| Tag | Source | Description | |
| 63 | +|-----|--------|-------------| |
| 64 | +| `:latest` | [Upstream Releases](https://services.sonarr.tv/v1/releases) | Latest upstream release | |
| 65 | +| `:pkg` | `net-p2p/sonarr` | FreeBSD quarterly packages | |
| 66 | +| `:pkg-latest` | `net-p2p/sonarr` | FreeBSD latest packages | |
| 67 | + |
| 68 | +## Environment Variables |
| 69 | + |
| 70 | +| Variable | Default | Description | |
| 71 | +|----------|---------|-------------| |
| 72 | +| `PUID` | 1000 | User ID for app | |
| 73 | +| `PGID` | 1000 | Group ID for app | |
| 74 | +| `TZ` | UTC | Timezone | |
| 75 | + |
| 76 | +## Volumes |
| 77 | + |
| 78 | +| Path | Description | |
| 79 | +|------|-------------| |
| 80 | +| `/config` | Configuration directory | |
| 81 | +| `/tv` | TV show library | |
| 82 | +| `/downloads` | Download directory | |
| 83 | + |
| 84 | +## Ports |
| 85 | + |
| 86 | +| Port | Description | |
| 87 | +|------|-------------| |
| 88 | +| 8989 | Web UI | |
| 89 | + |
| 90 | +## Notes |
| 91 | + |
| 92 | +- **User:** `bsd` (UID/GID set via PUID/PGID, default 1000) |
| 93 | +- **Base:** Built on `ghcr.io/daemonless/base-image` (FreeBSD) |
| 94 | + |
| 95 | +### Specific Requirements |
| 96 | +- **.NET App:** Requires `--annotation 'org.freebsd.jail.allow.mlock=true'` (Requires [patched ocijail](https://github.com/daemonless/daemonless#ocijail-patch)) |
| 97 | + |
| 98 | +## Links |
| 99 | + |
| 100 | +- [Website](https://sonarr.tv/) |
| 101 | +- [FreshPorts](https://www.freshports.org/net-p2p/sonarr/) |
0 commit comments