Hexy Templates

Outline

Outline is the fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.

Not yet tested productivity Based on TrueNAS app v1.2.48 (Outline 1.10.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Outline and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
outline.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS outline 1.2.48"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30144]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/outline"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/outline/data",
18      "snapshot": {"id": "data"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/outline/postgres_data",
22      "owner": {"user": "netdata", "group": "docker"},
23      "snapshot": {"id": "postgres_data"}
24    }
25  ],
26  "app_values": {
27    "outline": {
828      "db_password": "$RANDOM_STRING(16)",
929      "redis_password": "$RANDOM_STRING(16)",
1030      "secret_key": "$RANDOM_STRING(32)",
1131      "utils_secret": "$RANDOM_STRING(32)",
1232      "app_url": "http://$SERVER_LAN_IP:30144"
33    },
34    "storage": {
1335      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/outline/data)",
1436      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/outline/postgres_data)"
37    },
38    "network": {
1539      "web_port": {"bind_mode": "published", "port_number": 30144}
40    },
1641    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
42  }
43}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS outline 1.2.48”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 10

  6. Network ports

    The app needs port 30144 to be free on your server. A port is like an apartment number for your server's address.

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › outline, App storage (fast) › outline › data and App storage (fast) › outline › 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 13–25

  8. Auto-generated db password

    HexOS makes up a long random db password during install. It's only used inside Outline, so you never need to know it.

    Line 28

  9. Auto-generated redis password

    HexOS makes up a long random redis password during install. It's only used inside Outline, so you never need to know it.

    Line 29

  10. Auto-generated secret key

    HexOS makes up a long random secret key during install. It's only used inside Outline, so you never need to know it.

    Line 30

  11. Auto-generated utils secret

    HexOS makes up a long random utils secret during install. It's only used inside Outline, so you never need to know it.

    Line 31

  12. Your server's address (app url)

    Automatically set to your server's address on your home network (http://your-server-ip:30144).

    Line 32

  13. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › outline › data.

    Line 35

  14. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › outline › postgres_data.

    Line 36

  15. Web port: 30144

    The app's web page is published on port 30144. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 39

  16. 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 41