Hexy Templates

Vikunja

Vikunja is an open-source, self-hostable to-do app.

Tested productivity Based on TrueNAS app v2.0.69 (Vikunja 2.7.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 Vikunja and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
vikunja.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS vikunja 2.0.69"
6  },
37  "installation_questions": [
8    {"question": "Url", "type": "text", "key": "url", "required": true}
9  ],
10  "requirements": {
411    "locations": ["ApplicationsPerformance"],
512    "specifications": ["2CORE"],
613    "permissions": ["READ_WRITE_LOCATIONS"],
714    "ports": [30107]
15  },
816  "ensure_directories_exists": [
17    {"path": "$LOCATION(ApplicationsPerformance)"},
18    {"path": "$LOCATION(ApplicationsPerformance)/vikunja"},
19    {
20      "path": "$LOCATION(ApplicationsPerformance)/vikunja/data",
21      "snapshot": {"id": "data"}
22    },
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/vikunja/postgres_data",
25      "owner": {"user": "netdata", "group": "docker"},
26      "snapshot": {"id": "postgres_data"}
27    }
28  ],
29  "app_values": {
30    "vikunja": {
931      "url": "$QUESTION(url)",
1032      "jwt_secret": "$RANDOM_STRING(32)",
1133      "db_password": "$RANDOM_STRING(16)",
1234      "redis_password": "$RANDOM_STRING(16)"
35    },
36    "storage": {
1337      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/vikunja/data)",
1438      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/vikunja/postgres_data)"
39    },
40    "network": {
1541      "web_port": {"bind_mode": "published", "port_number": 30107}
42    },
1643    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
44  }
45}

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 vikunja 2.0.69”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–9

  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 11

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 12

  6. Permission to use your folders

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

    Line 13

  7. Network ports

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

    Line 14

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › vikunja, App storage (fast) › vikunja › data and App storage (fast) › vikunja › 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 16–28

  9. Your answer: url

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

    Line 31

  10. Auto-generated jwt secret

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

    Line 32

  11. Auto-generated db password

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

    Line 33

  12. Auto-generated redis password

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

    Line 34

  13. Where the app's main data is saved

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

    Line 37

  14. Where the app's database is saved

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

    Line 38

  15. Web port: 30107

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

    Line 41

  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 43