Hexy Templates

Calibre-Web Automated

A web application for managing Calibre eBook libraries with automated book ingestion.

Not yet tested media Based on TrueNAS app v1.0.3 (Calibre-Web Automated v4.0.8)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Calibre-Web Automated and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
calibre-web-automated.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS calibre-web-automated 1.0.3"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30437]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/calibre-web-automated"},
16    {"path": "$LOCATION(Media)", "network_share": true},
17    {
18      "path": "$LOCATION(ApplicationsPerformance)/calibre-web-automated/config",
19      "snapshot": {"id": "config"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/calibre-web-automated/library",
23      "snapshot": {"id": "library"}
24    },
25    {
26      "path": "$LOCATION(ApplicationsPerformance)/calibre-web-automated/book_ingest",
27      "snapshot": {"id": "book_ingest"}
28    }
29  ],
30  "app_values": {
31    "storage": {
832      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calibre-web-automated/config)",
933      "library": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calibre-web-automated/library)",
1034      "book_ingest": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calibre-web-automated/book_ingest)",
1135      "additional_storage": [
36        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
37      ]
38    },
39    "network": {
1240      "web_port": {"bind_mode": "published", "port_number": 30437}
41    },
1342    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
43  }
44}

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 calibre-web-automated 1.0.3”.

    Lines 3–6

  3. 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 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 30437 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) › calibre-web-automated, App storage (fast) › calibre-web-automated › config, App storage (fast) › calibre-web-automated › library and App storage (fast) › calibre-web-automated › book_ingest. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–29

  8. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › calibre-web-automated › config.

    Line 32

  9. Where your library is saved

    Where your library is saved on your server: App storage (fast) › calibre-web-automated › library.

    Line 33

  10. Where the app's “book ingest” files is saved

    Where the app's “book ingest” files is saved on your server: App storage (fast) › calibre-web-automated › book_ingest.

    Line 34

  11. Your shared folders

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

    Lines 35–37

  12. Web port: 30437

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

    Line 40

  13. 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 42