Hexy Templates

Planka

Planka is an Elegant open source project tracking

Not yet tested productivity Based on TrueNAS app v2.3.34 (Planka 2.2.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Planka and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
planka.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS planka 2.3.34"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30034]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/planka"},
16    {"path": "$LOCATION(ApplicationsCapacity)"},
17    {"path": "$LOCATION(ApplicationsCapacity)/planka"},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/planka/data",
20      "owner": {"user": "apps"},
21      "snapshot": {"id": "data"}
22    },
23    {
24      "path": "$LOCATION(ApplicationsCapacity)/planka/logs",
25      "owner": {"user": "apps"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/planka/postgres_data",
29      "owner": {"user": "netdata", "group": "docker"},
30      "snapshot": {"id": "postgres_data"}
31    }
32  ],
33  "app_values": {
34    "planka": {
835      "db_password": "$RANDOM_STRING(16)",
936      "secret_key": "$RANDOM_STRING(32)",
1037      "base_url": "http://$SERVER_LAN_IP:30034"
38    },
39    "storage": {
1140      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/planka/data)",
1241      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/planka/logs)",
1342      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/planka/postgres_data)"
43    },
44    "network": {
1445      "web_port": {"bind_mode": "published", "port_number": 30034}
46    },
1547    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
48  }
49}

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 planka 2.3.34”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and App storage (large). 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 30034 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) › planka, App storage (large) › planka, App storage (fast) › planka › data, App storage (large) › planka › logs and App storage (fast) › planka › 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 13–32

  8. Auto-generated db password

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

    Line 35

  9. Auto-generated secret key

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

    Line 36

  10. Your server's address (base url)

    Automatically set to your server's address on your home network (http://your-server-ip:30034).

    Line 37

  11. Where the app's main data is saved

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

    Line 40

  12. Where the app's log files is saved

    Where the app's log files is saved on your server: App storage (large) › planka › logs.

    Line 41

  13. Where the app's database is saved

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

    Line 42

  14. Web port: 30034

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

    Line 45

  15. 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 47