Skip to content

Commit 51f38e3

Browse files
committed
refactor: rename yml to yaml, add compose.yaml, fix workflow reference
1 parent c37a362 commit 51f38e3

5 files changed

Lines changed: 103 additions & 73 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
build:
13-
uses: daemonless/daemonless/.github/workflows/build-app.yml@main
13+
uses: daemonless/daemonless/.github/workflows/build-app.yaml@main
1414
with:
1515
image_name: radarr
1616
secrets: inherit
File renamed without changes.

README.md

Lines changed: 52 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,17 @@
1-
# radarr
1+
# Radarr
22

3-
Movie collection manager for Usenet and BitTorrent users.
3+
Radarr movie management on FreeBSD.
44

5-
## Environment Variables
5+
| | |
6+
|---|---|
7+
| **Port** | 7878 |
8+
| **Registry** | `ghcr.io/daemonless/radarr` |
9+
| **Source** | [https://github.com/Radarr/Radarr](https://github.com/Radarr/Radarr) |
10+
| **Website** | [https://radarr.video/](https://radarr.video/) |
611

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` |
12+
## Deployment
1513

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/radarr/`.
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-
```bash
25-
podman run -d --name radarr \
26-
-p 7878:7878 \
27-
--annotation 'org.freebsd.jail.allow.mlock=true' \
28-
-e PUID=1000 -e PGID=1000 \
29-
-v /path/to/config:/config \
30-
-v /path/to/movies:/movies \
31-
-v /path/to/downloads:/downloads \
32-
ghcr.io/daemonless/radarr:latest
33-
```
34-
35-
Access at: http://localhost:7878
36-
37-
## podman-compose
14+
### Podman Compose
3815

3916
```yaml
4017
services:
@@ -44,80 +21,83 @@ services:
4421
environment:
4522
- PUID=1000
4623
- PGID=1000
47-
- TZ=America/New_York
24+
- TZ=UTC
4825
volumes:
49-
- /data/config/radarr:/config
50-
- /data/media/movies:/movies
51-
- /data/downloads:/downloads
26+
- /path/to/containers/radarr:/config
27+
- /path/to/movies:/movies # optional
28+
- /path/to/downloads:/downloads # optional
5229
ports:
5330
- 7878:7878
5431
annotations:
5532
org.freebsd.jail.allow.mlock: "true"
5633
restart: unless-stopped
5734
```
5835
59-
## Ansible
36+
### Podman CLI
37+
38+
```bash
39+
podman run -d --name radarr \
40+
-p 7878:7878 \
41+
--annotation 'org.freebsd.jail.allow.mlock=true' \
42+
-e PUID=@PUID@ \
43+
-e PGID=@PGID@ \
44+
-e TZ=@TZ@ \
45+
-v /path/to/containers/radarr:/config \
46+
-v /path/to/movies:/movies \ # optional
47+
-v /path/to/downloads:/downloads \ # optional
48+
ghcr.io/daemonless/radarr:latest
49+
```
50+
Access at: `http://localhost:7878`
51+
52+
### Ansible
6053

6154
```yaml
62-
- name: Deploy Radarr
55+
- name: Deploy radarr
6356
containers.podman.podman_container:
6457
name: radarr
6558
image: ghcr.io/daemonless/radarr:latest
6659
state: started
67-
restart_policy: unless-stopped
60+
restart_policy: always
6861
env:
6962
PUID: "1000"
7063
PGID: "1000"
71-
TZ: "America/New_York"
64+
TZ: "UTC"
7265
ports:
7366
- "7878:7878"
7467
volumes:
75-
- /data/config/radarr:/config
76-
- /data/media/movies:/movies
77-
- /data/downloads:/downloads
68+
- "/path/to/containers/radarr:/config"
69+
- "/path/to/movies:/movies" # optional
70+
- "/path/to/downloads:/downloads" # optional
7871
annotation:
7972
org.freebsd.jail.allow.mlock: "true"
8073
```
8174
82-
## Tags
75+
## Configuration
8376
84-
| Tag | Source | Description |
85-
|-----|--------|-------------|
86-
| `:latest` | [Upstream Releases](https://radarr.servarr.com/) | Latest upstream release |
87-
| `:pkg` | `net-p2p/radarr` | FreeBSD quarterly packages |
88-
| `:pkg-latest` | `net-p2p/radarr` | FreeBSD latest packages |
89-
90-
## Environment Variables
77+
### Environment Variables
9178
9279
| Variable | Default | Description |
9380
|----------|---------|-------------|
94-
| `PUID` | 1000 | User ID for app |
95-
| `PGID` | 1000 | Group ID for app |
96-
| `TZ` | UTC | Timezone |
81+
| `PUID` | `1000` | User ID for the application process |
82+
| `PGID` | `1000` | Group ID for the application process |
83+
| `TZ` | `UTC` | Timezone for the container |
9784

98-
## Volumes
85+
### Volumes
9986

10087
| Path | Description |
10188
|------|-------------|
10289
| `/config` | Configuration directory |
103-
| `/movies` | Movie library |
104-
| `/downloads` | Download directory |
90+
| `/movies` | Movie library (Optional) |
91+
| `/downloads` | Download directory (Optional) |
10592

106-
## Ports
93+
### Ports
10794

108-
| Port | Description |
109-
|------|-------------|
110-
| 7878 | Web UI |
95+
| Port | Protocol | Description |
96+
|------|----------|-------------|
97+
| `7878` | TCP | Web UI |
11198

11299
## Notes
113100

114-
- **User:** `bsd` (UID/GID set via PUID/PGID, default 1000)
115-
- **Base:** Built on `ghcr.io/daemonless/base-image` (FreeBSD)
116-
117-
### Specific Requirements
118-
- **.NET App:** Requires `--annotation 'org.freebsd.jail.allow.mlock=true'` (Requires [patched ocijail](https://github.com/daemonless/daemonless#ocijail-patch))
119-
120-
## Links
121-
122-
- [Website](https://radarr.video/)
123-
- [FreshPorts](https://www.freshports.org/net-p2p/radarr/)
101+
- **User:** `bsd` (UID/GID set via PUID/PGID)
102+
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD)
103+
- **.NET App:** Requires `--annotation 'org.freebsd.jail.allow.mlock=true'` and a [patched ocijail](https://daemonless.io/guides/ocijail-patch).

compose.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: radarr
2+
3+
x-daemonless:
4+
title: "Radarr"
5+
icon: ":material-movie:"
6+
category: "Media Management"
7+
description: "Radarr movie management on FreeBSD."
8+
upstream_url: "https://github.com/Radarr/Radarr"
9+
web_url: "https://radarr.video/"
10+
freshports_url: "https://www.freshports.org/net-p2p/radarr/"
11+
user: "bsd"
12+
mlock: true
13+
14+
docs:
15+
env:
16+
PUID: "User ID for the application process"
17+
PGID: "Group ID for the application process"
18+
TZ: "Timezone for the container"
19+
volumes:
20+
/config: "Configuration directory"
21+
/movies:
22+
desc: "Movie library"
23+
optional: true
24+
/downloads:
25+
desc: "Download directory"
26+
optional: true
27+
ports:
28+
7878: "Web UI"
29+
30+
services:
31+
radarr:
32+
image: ghcr.io/daemonless/radarr:latest
33+
container_name: radarr
34+
restart: unless-stopped
35+
36+
annotations:
37+
org.freebsd.jail.allow.mlock: "true"
38+
39+
environment:
40+
- PUID=1000
41+
- PGID=1000
42+
- TZ=UTC
43+
44+
volumes:
45+
- /path/to/containers/radarr:/config
46+
- /path/to/movies:/movies
47+
- /path/to/downloads:/downloads
48+
49+
ports:
50+
- 7878:7878

0 commit comments

Comments
 (0)