Skip to content

Commit bd2f09e

Browse files
committed
docs: regenerate site with improved paths and cleaner templates
1 parent b965b4a commit bd2f09e

2 files changed

Lines changed: 20 additions & 3 deletions

File tree

docs/images/jellyfin.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ The Free Software Media System on FreeBSD.
2323
## Prerequisites
2424

2525
Before deploying, ensure your host environment is ready. See the [Quick Start Guide](../quick-start.md) for host setup instructions.
26+
!!! warning "Memory Locking (Critical)"
27+
This application is built on .NET and requires memory locking enabled in the jail.
28+
You **must** use the `allow.mlock` annotation and have a [patched ocijail](../guides/ocijail-patch.md).
2629

2730
## Deployment
2831

@@ -44,6 +47,8 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
4447
- @MOVIES_PATH@:/movies # optional
4548
ports:
4649
- @JELLYFIN_PORT@:8096
50+
annotations:
51+
org.freebsd.jail.allow.mlock: "true"
4752
restart: unless-stopped
4853
```
4954

@@ -52,6 +57,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
5257
```bash
5358
podman run -d --name jellyfin \
5459
-p @JELLYFIN_PORT@:8096 \
60+
--annotation 'org.freebsd.jail.allow.mlock=true' \
5561
-e PUID=@PUID@ \
5662
-e PGID=@PGID@ \
5763
-e TZ=@TZ@ \
@@ -82,6 +88,8 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
8288
- "@CONTAINER_CONFIG_ROOT@/@JELLYFIN_CACHE_PATH@:/cache" # optional
8389
- "@TV_PATH@:/tv" # optional
8490
- "@MOVIES_PATH@:/movies" # optional
91+
annotation:
92+
org.freebsd.jail.allow.mlock: "true"
8593
```
8694

8795
Access the Web UI at: `http://localhost:@JELLYFIN_PORT@`
@@ -116,6 +124,7 @@ Access the Web UI at: `http://localhost:@JELLYFIN_PORT@`
116124

117125
- **User:** `bsd` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.
118126
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.0).
127+
- **.NET App:** Requires `--annotation 'org.freebsd.jail.allow.mlock=true'` and a [patched ocijail](../guides/ocijail-patch.md).
119128

120129
[Website](https://jellyfin.org/){ .md-button .md-button--primary }
121130
[Source Code](https://github.com/jellyfin/jellyfin){ .md-button }

scripts/generate_docs.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,19 @@ def load_compose_config(repo_path):
148148
placeholder = f"@{config['name'].upper().replace('-', '_')}_CONFIG_PATH@"
149149
source_path = config['name']
150150
root_var = CONFIG_ROOT_VAR
151-
elif src.startswith(DEFAULT_CONFIG_ROOT):
152-
# Respect explicit source path from compose.yaml
153-
source_path = src.replace(DEFAULT_CONFIG_ROOT, "").lstrip("/")
151+
elif src.startswith("./") or src.startswith("."):
152+
# Use explicit relative source from compose.yaml
153+
clean_src = src.lstrip("./")
154+
source_path = f"{config['name']}/{clean_src}"
155+
root_var = CONFIG_ROOT_VAR
156+
placeholder = f"@{config['name'].upper().replace('-', '_')}_{clean_src.upper()}_PATH@"
157+
elif "/path/to/containers" in src:
158+
# Handle absolute paths matching standard prefix
159+
clean_src = src.replace("/path/to/containers/", "")
160+
source_path = clean_src.lstrip("/")
154161
root_var = CONFIG_ROOT_VAR
155162
# Generate placeholder from the clean source path
163+
# e.g. immich/postgres -> IMMICH_POSTGRES_PATH
156164
placeholder_suffix = source_path.replace("/", "_").replace("-", "_").upper()
157165
placeholder = f"@{placeholder_suffix}_PATH@"
158166
else:

0 commit comments

Comments
 (0)