Hexy Templates

Grimmory

Grimmory is a self-hosted application for managing your entire book collection in one place. Organize, read, annotate, sync across devices, and share without relying on third-party services.

Not yet tested media Based on TrueNAS app v1.0.22 (Grimmory v3.5.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 Grimmory and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
grimmory.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS grimmory 1.0.22"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "Documents", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30396]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/grimmory"},
16    {"path": "$LOCATION(Documents)", "network_share": true},
17    {"path": "$LOCATION(Media)", "network_share": true},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/grimmory/data",
20      "snapshot": {"id": "data"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/grimmory/bookdrop",
24      "snapshot": {"id": "bookdrop"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/grimmory/mariadb_data",
28      "owner": {"user": "netdata", "group": "docker"},
29      "snapshot": {"id": "mariadb_data"}
30    }
31  ],
32  "app_values": {
33    "grimmory": {
834      "db_password": "$RANDOM_STRING(16)",
935      "db_root_password": "$RANDOM_STRING(16)"
36    },
37    "storage": {
1038      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/grimmory/data)",
1139      "books": "$HOST_PATH($LOCATION(Documents))",
1240      "bookdrop": "$HOST_PATH($LOCATION(ApplicationsPerformance)/grimmory/bookdrop)",
1341      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/grimmory/mariadb_data)",
1442      "additional_storage": [
43        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
44      ]
45    },
46    "network": {
1547      "web_port": {"bind_mode": "published", "port_number": 30396}
48    },
1649    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
50  }
51}

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 grimmory 1.0.22”.

    Lines 3–6

  3. 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 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 30396 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) › grimmory, App storage (fast) › grimmory › data, App storage (fast) › grimmory › bookdrop and App storage (fast) › grimmory › 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–31

  8. Auto-generated db password

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

    Line 34

  9. Auto-generated db root password

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

    Line 35

  10. Where the app's main data is saved

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

    Line 38

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

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

    Line 39

  12. Where the app's “bookdrop” files is saved

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

    Line 40

  13. Where the app's database is saved

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

    Line 41

  14. Your shared folders

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

    Lines 42–44

  15. Web port: 30396

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

    Line 47

  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 49