Hexy Templates

LazyLibrarian

LazyLibrarian is a program to follow authors and grab metadata for all your digital reading needs.

Not yet tested media Based on TrueNAS app v1.1.93 (LazyLibrarian 978c264e-ls362)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find LazyLibrarian and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
lazylibrarian.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS lazylibrarian 1.1.93"
6  },
7  "requirements": {
38    "locations": [
9      "ApplicationsPerformance",
10      "Downloads",
11      "Documents",
12      "Media"
13    ],
414    "specifications": ["2CORE"],
515    "permissions": ["READ_WRITE_LOCATIONS"],
616    "ports": [31089]
17  },
718  "ensure_directories_exists": [
19    {"path": "$LOCATION(ApplicationsPerformance)"},
20    {"path": "$LOCATION(ApplicationsPerformance)/lazylibrarian"},
21    {"path": "$LOCATION(Downloads)", "network_share": true},
22    {"path": "$LOCATION(Documents)", "network_share": true},
23    {"path": "$LOCATION(Media)", "network_share": true},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/lazylibrarian/config",
26      "snapshot": {"id": "config"}
27    }
28  ],
29  "app_values": {
30    "storage": {
831      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/lazylibrarian/config)",
932      "downloads": "$HOST_PATH($LOCATION(Downloads))",
1033      "books": "$HOST_PATH($LOCATION(Documents))",
1134      "additional_storage": [
35        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
36      ]
37    },
38    "network": {
1239      "web_port": {"bind_mode": "published", "port_number": 31089}
40    },
1341    "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 lazylibrarian 1.1.93”.

    Lines 3–6

  3. Storage locations it needs

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

    Lines 8–13

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 14

  5. Permission to use your folders

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

    Line 15

  6. Network ports

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

    Line 16

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › lazylibrarian and App storage (fast) › lazylibrarian › config. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 18–28

  8. Where the app's settings is saved

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

    Line 31

  9. Where the app's “downloads” files is saved

    Where the app's “downloads” files is saved on your server: Downloads.

    Line 32

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

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

    Line 33

  11. Your shared folders

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

    Lines 34–36

  12. Web port: 31089

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

    Line 39

  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 41