Paperless-ngx
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.
- 1Copy the script below
- 2In HexOS, open Apps, find Paperless-ngx 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 paperless-ngx 1.6.56"
6 },
37 "installation_questions": [
8 {
9 "question": "Admin user",
10 "type": "text",
11 "key": "admin_user",
12 "required": true
13 },
14 {
15 "question": "Admin mail",
16 "type": "text",
17 "key": "admin_mail",
18 "required": true
19 },
20 {
21 "question": "Admin password",
22 "type": "password",
23 "key": "admin_password",
24 "required": true
25 }
26 ],
27 "requirements": {
428 "locations": ["ApplicationsPerformance", "Media"],
529 "specifications": ["2CORE"],
630 "permissions": ["READ_WRITE_LOCATIONS"],
731 "ports": [30070]
32 },
833 "ensure_directories_exists": [
34 {"path": "$LOCATION(ApplicationsPerformance)"},
35 {"path": "$LOCATION(ApplicationsPerformance)/paperless-ngx"},
36 {"path": "$LOCATION(Media)", "network_share": true},
37 {
38 "path": "$LOCATION(ApplicationsPerformance)/paperless-ngx/data",
39 "snapshot": {"id": "data"}
40 },
41 {
42 "path": "$LOCATION(ApplicationsPerformance)/paperless-ngx/consume",
43 "snapshot": {"id": "consume"}
44 },
45 {
46 "path": "$LOCATION(ApplicationsPerformance)/paperless-ngx/trash",
47 "snapshot": {"id": "trash"}
48 },
49 {
50 "path": "$LOCATION(ApplicationsPerformance)/paperless-ngx/postgres_data",
51 "owner": {"user": "netdata", "group": "docker"},
52 "snapshot": {"id": "postgres_data"}
53 }
54 ],
55 "app_values": {
56 "paperless": {
957 "db_password": "$RANDOM_STRING(16)",
1058 "redis_password": "$RANDOM_STRING(16)",
1159 "secret_key": "$RANDOM_STRING(32)",
1260 "admin_user": "$QUESTION(admin_user)",
1361 "admin_mail": "$QUESTION(admin_mail)",
1462 "admin_password": "$QUESTION(admin_password)"
63 },
64 "storage": {
1565 "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/paperless-ngx/data)",
1666 "media": "$HOST_PATH($LOCATION(Media))",
1767 "consume": "$HOST_PATH($LOCATION(ApplicationsPerformance)/paperless-ngx/consume)",
1868 "trash": "$HOST_PATH($LOCATION(ApplicationsPerformance)/paperless-ngx/trash)",
1969 "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/paperless-ngx/postgres_data)"
70 },
71 "network": {
2072 "web_port": {"bind_mode": "published", "port_number": 30070}
73 },
2174 "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
75 }
76}
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 paperless-ngx 1.6.56”.
Lines 3–6
-
Questions you'll be asked
Before installing, HexOS will ask you for: Admin user, Admin mail and Admin password. Your answers are slotted into the settings further down wherever you see $QUESTION(...).
Lines 7–26
-
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 28
-
Minimum hardware
Recommended minimum: 2 CPU cores.
Line 29
-
Permission to use your folders
Allows the app to read and write files inside the storage locations listed above — and nowhere else.
Line 30
-
Network ports
The app needs port 30070 to be free on your server. A port is like an apartment number for your server's address.
Line 31
-
Folders created on install
Creates the folders the app needs before it starts: App storage (fast) › paperless-ngx, App storage (fast) › paperless-ngx › data, App storage (fast) › paperless-ngx › consume, App storage (fast) › paperless-ngx › trash and App storage (fast) › paperless-ngx › 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 33–54
-
Auto-generated db password
HexOS makes up a long random db password during install. It's only used inside Paperless-ngx, so you never need to know it.
Line 57
-
Auto-generated redis password
HexOS makes up a long random redis password during install. It's only used inside Paperless-ngx, so you never need to know it.
Line 58
-
Auto-generated secret key
HexOS makes up a long random secret key during install. It's only used inside Paperless-ngx, so you never need to know it.
Line 59
-
Your answer: admin user
Filled in with what you typed for “admin user” when you installed.
Line 60
-
Your answer: admin mail
Filled in with what you typed for “admin mail” when you installed.
Line 61
-
Your answer: admin password
Filled in with what you typed for “admin password” when you installed.
Line 62
-
Where the app's main data is saved
Where the app's main data is saved on your server: App storage (fast) › paperless-ngx › data.
Line 65
-
Where your media is saved
Where your media is saved on your server: Media.
Line 66
-
Where the app's “consume” files is saved
Where the app's “consume” files is saved on your server: App storage (fast) › paperless-ngx › consume.
Line 67
-
Where the app's “trash” files is saved
Where the app's “trash” files is saved on your server: App storage (fast) › paperless-ngx › trash.
Line 68
-
Where the app's database is saved
Where the app's database is saved on your server: App storage (fast) › paperless-ngx › postgres_data.
Line 69
-
Web port: 30070
The app's web page is published on port 30070. You don't need to remember it — clicking the app's card in HexOS takes you there.
Line 72
-
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 74