jramos/truenas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(truenas): add comprehensive Docker apps/containers documentation

Browse Source 
- Added TRUENAS_APPS.md with complete documentation of all 13 Docker containers
- Documented container health status, networking, storage mounts, and configurations
- Included disaster recovery export (truenas-apps-export-20251216-143515) with:
  - Individual container configs and metadata
  - Docker images, networks, volumes, and compose projects
  - App configuration and mount point listings
- Updated README.md to reference TRUENAS_APPS.md in documentation index
- Updated scribe.md timestamp

This establishes comprehensive documentation for TrueNAS Scale Docker infrastructure
including Plex, *arr stack (Sonarr/Radarr/Bazarr/Prowlarr), Deluge, Gluetun VPN,
FlareSolverr, Dockge, and Beszel monitoring agent.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Jordan Ramos
2025-12-16 18:45:46 -07:00
parent ddef5cfaa2
commit 10de51a307
26 changed files with 18287 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

553
disaster-recovery/truenas-apps-export-20251216-143515/configs/apps/metadata.yaml Normal file
View File

@@ -0,0 +1,553 @@
beszel:
custom_app: true
human_version: 1.0.0_custom
metadata:
app_version: custom
capabilities: []
description: This is a custom app where user can use his/her own docker compose
file for deploying services
home: ''
host_mounts: []
maintainers: []
name: custom-app
run_as_context: []
sources: []
title: Custom App
train: stable
version: 1.0.0
migrated: false
notes: null
portals: {}
version: 1.0.0
dockge:
custom_app: false
human_version: 1.5.0_1.2.14
metadata:
annotations:
min_scale_version: 24.10.2.2
app_version: 1.5.0
capabilities:
- description: Dockge is able to change file ownership arbitrarily
name: CHOWN
- description: Dockge is able to bypass file permission checks
name: DAC_OVERRIDE
- description: Dockge is able to bypass permission checks for file operations
name: FOWNER
- description: Dockge is able to send signals to any process
name: KILL
- description: Dockge is able to set file capabilities on other files
name: SETFCAP
- description: Dockge is able to change group ID of processes
name: SETGID
- description: Dockge is able to transfer capabilities between processes
name: SETPCAP
- description: Dockge is able to change user ID of processes
name: SETUID
categories:
- management
changelog_url: https://github.com/louislam/dockge/releases
date_added: '2024-08-01'
description: A fancy, easy-to-use and reactive self-hosted docker compose.yaml
stack-oriented manager
home: https://dockge.kuma.pet
host_mounts:
- description: Docker socket
host_path: /var/run/docker.sock
icon: https://media.sys.truenas.net/apps/dockge/icons/icon.svg
keywords:
- docker
- compose
last_update: '2025-11-28 16:17:12'
lib_version: 2.1.65
lib_version_hash: f92a9ee78c78fc77f86e7d8b545bd4c605c31c599e2c5da59f1615aa516cb8b5
maintainers:
- email: dev@truenas.com
name: truenas
url: https://www.truenas.com/
name: dockge
run_as_context:
- description: Dockge runs as root user.
gid: 0
group_name: root
uid: 0
user_name: root
screenshots:
- https://media.sys.truenas.net/apps/dockge/screenshots/screenshot1.png
sources:
- https://dockge.kuma.pet
- https://github.com/louislam/dockge
title: Dockge
train: community
version: 1.2.14
migrated: false
notes: '# Dockge
## Security
**Read the following security precautions to ensure that you wish to continue
using this application.**
---
### Container: [dockge]
#### Running user/group(s)
- User: root
- Group: root
- Supplementary Groups: apps, docker
#### Passing Host Files, Devices, or Sockets into the Container
- Docker Socket (/var/run/docker.sock) - (Read/Write)
---
## Bug Reports and Feature Requests
If you find a bug in this app or have an idea for a new feature, please file an
issue at
https://github.com/truenas/apps
'
portals:
Web UI: http://0.0.0.0:31014/
version: 1.2.14
open-speed-test:
custom_app: false
human_version: v2.0.6_1.0.21
metadata:
app_version: v2.0.6
capabilities: []
categories:
- networking
changelog_url: https://github.com/openspeedtest/Docker-Image/tags
date_added: '2025-02-05'
description: "SpeedTest by OpenSpeedTest\u2122 is a Free and Open-Source HTML5\
\ Network Performance Estimation Tool"
home: https://openspeedtest.com
host_mounts: []
icon: https://media.sys.truenas.net/apps/open-speed-test/icons/icon.svg
keywords:
- speedtest
last_update: '2025-11-15 15:15:59'
lib_version: 2.1.57
lib_version_hash: 6659ad369fff2f1df318cb6353bb32bffe7047dc21df4823750d39be7284e605
maintainers:
- email: dev@truenas.com
name: truenas
url: https://www.truenas.com/
name: open-speed-test
run_as_context:
- description: Open Speed Test runs as non-root user.
gid: 101
group_name: nginx
uid: 101
user_name: nginx
screenshots:
- https://media.sys.truenas.net/apps/open-speed-test/screenshots/screenshot1.gif
sources:
- https://github.com/openspeedtest/Speed-Test
title: Open Speed Test
train: community
version: 1.0.21
migrated: false
notes: '# Open Speed Test
## Security
**Read the following security precautions to ensure that you wish to continue
using this application.**
---
### Container: [open-speed-test]
#### Running user/group(s)
- User: 101
- Group: 101
- Supplementary Groups: apps
---
## Bug Reports and Feature Requests
If you find a bug in this app or have an idea for a new feature, please file an
issue at
https://github.com/truenas/apps
'
portals:
HTTP: http://0.0.0.0:30116/
HTTPS: https://0.0.0.0:30117/
version: 1.0.21
paperless-ngx:
custom_app: false
human_version: 2.18.4_1.3.27
metadata:
annotations:
min_scale_version: 24.10.2.2
app_version: 2.18.4
capabilities:
- description: Paperless is able to change file ownership arbitrarily
name: CHOWN
- description: Paperless is able to bypass file permission checks
name: DAC_OVERRIDE
- description: Paperless is able to bypass permission checks for file operations
name: FOWNER
- description: Paperless is able to change group ID of processes
name: SETGID
- description: Paperless is able to change user ID of processes
name: SETUID
categories:
- productivity
changelog_url: https://github.com/paperless-ngx/paperless-ngx/releases
date_added: '2024-09-10'
description: Paperless-ngx is a document management system that transforms your
physical documents into a searchable online archive so you can keep, well, less
paper.
home: https://docs.paperless-ngx.com
host_mounts: []
icon: https://media.sys.truenas.net/apps/paperless-ngx/icons/icon.svg
keywords:
- document
- management
lib_version: 2.1.50
lib_version_hash: 82f6bd4b66d71cc5456607ea1faed36d33faca43a0af1c6555704df4c2104460
maintainers:
- email: dev@ixsystems.com
name: truenas
url: https://www.truenas.com/
name: paperless-ngx
run_as_context:
- description: Paperless-ngx runs as root user.
gid: 0
group_name: root
uid: 0
user_name: root
- description: Postgres runs as non-root user.
gid: 999
group_name: postgres
uid: 999
user_name: postgres
- description: Redis runs as any non-root user.
gid: 568
group_name: redis
uid: 568
user_name: redis
- description: Tika runs as a non-root user.
gid: 35002
group_name: tika
uid: 35002
user_name: tika
- description: Gotenberg runs as a non-root user.
gid: 1001
group_name: gotenberg
uid: 1001
user_name: gotenberg
screenshots:
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot1.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot2.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot3.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot4.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot5.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot6.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot7.png
- https://media.sys.truenas.net/apps/paperless-ngx/screenshots/screenshot8.png
sources:
- https://hub.docker.com/r/paperlessngx/paperless-ngx
- https://github.com/paperless-ngx/paperless-ngx
title: Paperless-ngx
train: community
version: 1.3.27
migrated: false
notes: '# Paperless-ngx
## Security
**Read the following security precautions to ensure that you wish to continue
using this application.**
---
### Container: [gotenberg]
#### Running user/group(s)
- User: 1001
- Group: 1001
- Supplementary Groups: apps
---
### Container: [paperless]
#### Running user/group(s)
- User: root
- Group: root
- Supplementary Groups: apps
---
### Container: [postgres]
#### Running user/group(s)
- User: 999
- Group: 999
- Supplementary Groups: apps
---
### Container: [redis]
#### Running user/group(s)
- User: 568
- Group: 568
- Supplementary Groups: apps
---
### Container: [tika]
#### Running user/group(s)
- User: 35002
- Group: 35002
- Supplementary Groups: apps
---
### Container: [permissions]
**This container is short-lived.**
#### Running user/group(s)
- User: root
- Group: root
- Supplementary Groups: apps
---
### Container: [postgres_upgrade]
**This container is short-lived.**
#### Running user/group(s)
- User: 999
- Group: 999
- Supplementary Groups: apps
---
## Bug Reports and Feature Requests
If you find a bug in this app or have an idea for a new feature, please file an
issue at
https://github.com/truenas/apps
'
portals:
Web UI: http://0.0.0.0:30070/
version: 1.3.27
plex:
custom_app: false
human_version: 1.42.2.10156-f737b826c_1.2.19
metadata:
annotations:
min_scale_version: 24.10.2.2
app_version: 1.42.2.10156-f737b826c
capabilities:
- description: Plex is able to change file ownership arbitrarily
name: CHOWN
- description: Plex is able to bypass file permission checks
name: DAC_OVERRIDE
- description: Plex is able to bypass permission checks for file operations
name: FOWNER
- description: Plex is able to send signals to any process
name: KILL
- description: Plex is able to change group ID of processes
name: SETGID
- description: Plex is able to change user ID of processes
name: SETUID
categories:
- media
changelog_url: https://forums.plex.tv/t/plex-media-server/30447/
date_added: '2024-07-23'
description: Plex is a media server that allows you to stream your media to any
Plex client.
home: https://plex.tv
host_mounts: []
icon: https://media.sys.truenas.net/apps/plex/icons/icon.png
keywords:
- plex
- media
- entertainment
- movies
- series
- tv
- streaming
lib_version: 2.1.65
lib_version_hash: f92a9ee78c78fc77f86e7d8b545bd4c605c31c599e2c5da59f1615aa516cb8b5
maintainers:
- email: dev@truenas.com
name: truenas
url: https://www.truenas.com/
name: plex
run_as_context:
- description: Plex runs as root user.
gid: 0
group_name: root
uid: 0
user_name: root
screenshots:
- https://media.sys.truenas.net/apps/plex/screenshots/screenshot1.png
- https://media.sys.truenas.net/apps/plex/screenshots/screenshot2.png
sources:
- https://plex.tv
- https://hub.docker.com/r/plexinc/pms-docker
title: Plex
train: stable
version: 1.2.19
migrated: false
notes: '# Plex
## Security
**Read the following security precautions to ensure that you wish to continue
using this application.**
---
### Container: [plex]
#### Running user/group(s)
- User: root
- Group: root
- Supplementary Groups: apps
---
### Container: [permissions]
**This container is short-lived.**
#### Running user/group(s)
- User: root
- Group: root
- Supplementary Groups: apps
---
## Bug Reports and Feature Requests
If you find a bug in this app or have an idea for a new feature, please file an
issue at
https://github.com/truenas/apps
'
portals:
Web UI: http://0.0.0.0:32400/web
version: 1.2.19