Hexy Templates

BookOrbit

A self-hosted library management and reading platform for ebooks, PDFs, audiobooks, and comics.

Tested media Based on TrueNAS app v1.0.29 (BookOrbit 3.2.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find BookOrbit and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
bookorbit.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS bookorbit 1.0.29"
6  },
37  "installation_questions": [
8    {
9      "question": "Bootstrap token",
10      "type": "password",
11      "key": "bootstrap_token",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance", "Documents", "Media"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30441]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/bookorbit"},
24    {"path": "$LOCATION(Documents)", "network_share": true},
25    {"path": "$LOCATION(Media)", "network_share": true},
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/bookorbit/data",
28      "owner": {"user": "apps"},
29      "snapshot": {"id": "data"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/bookorbit/book_drop",
33      "owner": {"user": "apps"},
34      "snapshot": {"id": "book_drop"}
35    },
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/bookorbit/postgres_data",
38      "owner": {"user": "netdata", "group": "docker"},
39      "snapshot": {"id": "postgres_data"}
40    }
41  ],
42  "app_values": {
43    "bookorbit": {
944      "db_password": "$RANDOM_STRING(16)",
1045      "jwt_secret": "$RANDOM_STRING(32)",
1146      "bootstrap_token": "$QUESTION(bootstrap_token)"
47    },
48    "storage": {
1249      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookorbit/data)",
1350      "books": "$HOST_PATH($LOCATION(Documents))",
1451      "book_drop": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookorbit/book_drop)",
1552      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bookorbit/postgres_data)",
1653      "additional_storage": [
54        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
55      ]
56    },
57    "network": {
1758      "web_port": {"bind_mode": "published", "port_number": 30441}
59    },
1860    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
61  }
62}

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 bookorbit 1.0.29”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Bootstrap token. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. Storage locations it needs

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

    Line 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › bookorbit, App storage (fast) › bookorbit › data, App storage (fast) › bookorbit › book_drop and App storage (fast) › bookorbit › 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 21–41

  9. Auto-generated db password

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

    Line 44

  10. Auto-generated jwt secret

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

    Line 45

  11. Your answer: bootstrap token

    Filled in with what you typed for “bootstrap token” when you installed.

    Line 46

  12. Where the app's main data is saved

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

    Line 49

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

    Where the app's “books” files is saved on your server: Documents.

    Line 50

  14. Where the app's “book drop” files is saved

    Where the app's “book drop” files is saved on your server: App storage (fast) › bookorbit › book_drop.

    Line 51

  15. Where the app's database is saved

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

    Line 52

  16. Your shared folders

    Gives the app access to your existing files: Media appears inside the app as /media.

    Lines 53–55

  17. Web port: 30441

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

    Line 58

  18. 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 60