PeerTube
Self-hosted video platform and federated video streaming server.
- 1Copy the script below
- 2In HexOS, open Apps, find PeerTube and choose Custom Install
- 3Paste, then press Install — full guide with screenshots
1{
12 "version": 5,
23 "script": {
4 "version": "0.1.0",
5 "changeLog": "Auto-generated draft from TrueNAS peertube 1.0.24"
6 },
37 "installation_questions": [
8 {
9 "question": "Admin email",
10 "type": "text",
11 "key": "admin_email",
12 "required": true
13 },
14 {
15 "question": "Webserver hostname",
16 "type": "text",
17 "key": "webserver_hostname",
18 "required": true
19 }
20 ],
21 "requirements": {
422 "locations": ["ApplicationsPerformance", "Media"],
523 "specifications": ["2CORE"],
624 "permissions": ["READ_WRITE_LOCATIONS"],
725 "ports": [30434, 30435]
26 },
827 "ensure_directories_exists": [
28 {"path": "$LOCATION(ApplicationsPerformance)"},
29 {"path": "$LOCATION(ApplicationsPerformance)/peertube"},
30 {"path": "$LOCATION(Media)", "network_share": true},
31 {
32 "path": "$LOCATION(ApplicationsPerformance)/peertube/data",
33 "owner": {"user": "apps"},
34 "snapshot": {"id": "data"}
35 },
36 {
37 "path": "$LOCATION(ApplicationsPerformance)/peertube/config",
38 "owner": {"user": "apps"},
39 "snapshot": {"id": "config"}
40 },
41 {
42 "path": "$LOCATION(ApplicationsPerformance)/peertube/postgres_data",
43 "owner": {"user": "netdata", "group": "docker"},
44 "snapshot": {"id": "postgres_data"}
45 }
46 ],
47 "app_values": {
48 "peertube": {
949 "db_password": "$RANDOM_STRING(16)",
1050 "redis_password": "$RANDOM_STRING(16)",
1151 "secret": "$RANDOM_STRING(32)",
1252 "admin_email": "$QUESTION(admin_email)",
1353 "initial_root_password": "$RANDOM_STRING(16)",
1454 "webserver_hostname": "$QUESTION(webserver_hostname)"
55 },
56 "storage": {
1557 "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/peertube/data)",
1658 "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/peertube/config)",
1759 "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/peertube/postgres_data)",
1860 "additional_storage": [
61 "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
62 ]
63 },
64 "network": {
1965 "web_port": {"bind_mode": "published", "port_number": 30434},
2066 "rtmp_port": {"bind_mode": "published", "port_number": 30435}
67 },
2168 "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
69 }
70}
What this script does
Hover or tap a box to see the lines it explains.
-
Script format
Tells HexOS this is a version 5 install script, so it knows how to read the rest.
Line 2
-
Script revision
This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS peertube 1.0.24”.
Lines 3–6
-
Questions you'll be asked
Before installing, HexOS will ask you for: Admin email and Webserver hostname. Your answers are slotted into the settings further down wherever you see $QUESTION(...).
Lines 7–20
-
Storage locations it needs
The app uses these HexOS storage locations: App storage (fast) and Media. If one isn't set up yet, HexOS will ask you to pick a place for it.
Line 22
-
Minimum hardware
Recommended minimum: 2 CPU cores.
Line 23
-
Permission to use your folders
Allows the app to read and write files inside the storage locations listed above — and nowhere else.
Line 24
-
Network ports
The app needs ports 30434 and 30435 to be free on your server. A port is like an apartment number for your server's address.
Line 25
-
Folders created on install
Creates the folders the app needs before it starts: App storage (fast) › peertube, App storage (fast) › peertube › data, App storage (fast) › peertube › config and App storage (fast) › peertube › postgres_data. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.
Lines 27–46
-
Auto-generated db password
HexOS makes up a long random db password during install. It's only used inside PeerTube, so you never need to know it.
Line 49
-
Auto-generated redis password
HexOS makes up a long random redis password during install. It's only used inside PeerTube, so you never need to know it.
Line 50
-
Auto-generated secret
HexOS makes up a long random secret during install. It's only used inside PeerTube, so you never need to know it.
Line 51
-
Your answer: admin email
Filled in with what you typed for “admin email” when you installed.
Line 52
-
Auto-generated initial root password
HexOS makes up a long random initial root password during install. It's only used inside PeerTube, so you never need to know it.
Line 53
-
Your answer: webserver hostname
Filled in with what you typed for “webserver hostname” when you installed.
Line 54
-
Where the app's main data is saved
Where the app's main data is saved on your server: App storage (fast) › peertube › data.
Line 57
-
Where the app's settings is saved
Where the app's settings is saved on your server: App storage (fast) › peertube › config.
Line 58
-
Where the app's database is saved
Where the app's database is saved on your server: App storage (fast) › peertube › postgres_data.
Line 59
-
Your shared folders
Gives the app access to your existing files: Media appears inside the app as /media.
Lines 60–62
-
Web port: 30434
The app's web page is published on port 30434. You don't need to remember it — clicking the app's card in HexOS takes you there.
Line 65
-
Rtmp port: 30435
Publishes the app's rtmp port as 30435.
Line 66
-
Resource limits
Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.
Line 68