Hexy Templates

wallabag

wallabag is a self hostable application for saving web pages: Save and classify articles. Read them later. Freely.

Not yet tested productivity Based on TrueNAS app v1.0.2 (wallabag 2.6.14)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find wallabag and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
wallabag.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS wallabag 1.0.2"
6  },
37  "installation_questions": [
8    {
9      "question": "Domain name",
10      "type": "text",
11      "key": "domain_name",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30430]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/wallabag"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/wallabag/data",
26      "snapshot": {"id": "data"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/wallabag/images",
30      "snapshot": {"id": "images"}
31    }
32  ],
33  "app_values": {
934    "wallabag": {"domain_name": "$QUESTION(domain_name)"},
35    "storage": {
1036      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/wallabag/data)",
1137      "images": "$HOST_PATH($LOCATION(ApplicationsPerformance)/wallabag/images)"
38    },
39    "network": {
1240      "web_port": {"bind_mode": "published", "port_number": 30430}
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 wallabag 1.0.2”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Domain name. 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). 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 30430 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) › wallabag, App storage (fast) › wallabag › data and App storage (fast) › wallabag › images. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 21–32

  9. Your answer: domain name

    Filled in with what you typed for “domain name” when you installed.

    Line 34

  10. Where the app's main data is saved

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

    Line 36

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

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

    Line 37

  12. Web port: 30430

    The app's web page is published on port 30430. 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