Hexy Templates

BookStack

BookStack is a simple, self-hosted, easy-to-use platform for organizing and storing information

Not yet tested productivity Based on TrueNAS app v1.2.26 (BookStack 26.9.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 BookStack and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
bookstack.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS bookstack 1.2.26"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30214]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/bookstack"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/bookstack/uploads",
18      "snapshot": {"id": "uploads"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/bookstack/storage_uploads",
22      "snapshot": {"id": "storage_uploads"}
23    },
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/bookstack/mariadb_data",
26      "owner": {"user": "netdata", "group": "docker"},
27      "snapshot": {"id": "mariadb_data"}
28    }
29  ],
30  "app_values": {
31    "bookstack": {
832      "db_password": "$RANDOM_STRING(16)",
933      "db_root_password": "$RANDOM_STRING(16)",
1034      "app_url": "http://$SERVER_LAN_IP:30214",
1135      "app_key": "$RANDOM_STRING(32)"
36    },
37    "storage": {
1238      "uploads": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookstack/uploads)",
1339      "storage_uploads": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookstack/storage_uploads)",
1440      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookstack/mariadb_data)"
41    },
42    "network": {
1543      "web_port": {"bind_mode": "published", "port_number": 30214}
44    },
1645    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
46  }
47}

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 bookstack 1.2.26”.

    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 30214 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) › bookstack, App storage (fast) › bookstack › uploads, App storage (fast) › bookstack › storage_uploads and App storage (fast) › bookstack › mariadb_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–29

  8. Auto-generated db password

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

    Line 32

  9. Auto-generated db root password

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

    Line 33

  10. Your server's address (app url)

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

    Line 34

  11. Auto-generated app key

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

    Line 35

  12. Where files you upload is saved

    Where files you upload is saved on your server: App storage (fast) › bookstack › uploads.

    Line 38

  13. Where the app's “storage uploads” files is saved

    Where the app's “storage uploads” files is saved on your server: App storage (fast) › bookstack › storage_uploads.

    Line 39

  14. Where the app's database is saved

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

    Line 40

  15. Web port: 30214

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

    Line 43

  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 45