Hexy Templates

Kimai

Kimai is a web-based multi-user time-tracking application.

Not yet tested productivity Based on TrueNAS app v1.2.17 (Kimai apache-2.57.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 Kimai and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
kimai.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS kimai 1.2.17"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin mail",
10      "type": "text",
11      "key": "admin_mail",
12      "required": true
13    },
14    {
15      "question": "Admin password",
16      "type": "password",
17      "key": "admin_password",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30237]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/kimai"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/kimai/data",
32      "snapshot": {"id": "data"}
33    },
34    {
35      "path": "$LOCATION(ApplicationsPerformance)/kimai/plugins",
36      "snapshot": {"id": "plugins"}
37    },
38    {
39      "path": "$LOCATION(ApplicationsPerformance)/kimai/mariadb_data",
40      "owner": {"user": "netdata", "group": "docker"},
41      "snapshot": {"id": "mariadb_data"}
42    }
43  ],
44  "app_values": {
45    "kimai": {
946      "db_password": "$RANDOM_STRING(16)",
1047      "db_root_password": "$RANDOM_STRING(16)",
1148      "admin_mail": "$QUESTION(admin_mail)",
1249      "admin_password": "$QUESTION(admin_password)",
1350      "app_secret": "$RANDOM_STRING(32)"
51    },
52    "storage": {
1453      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/kimai/data)",
1554      "plugins": "$HOST_PATH($LOCATION(ApplicationsPerformance)/kimai/plugins)",
1655      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/kimai/mariadb_data)"
56    },
57    "network": {
1758      "web_port": {"bind_mode": "published", "port_number": 30237}
59    },
1860    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
61  }
62}

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 kimai 1.2.17”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–20

  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 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

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

    Line 24

  7. Network ports

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

    Line 25

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › kimai, App storage (fast) › kimai › data, App storage (fast) › kimai › plugins and App storage (fast) › kimai › mariadb_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 27–43

  9. Auto-generated db password

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

    Line 46

  10. Auto-generated db root password

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

    Line 47

  11. Your answer: admin mail

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

    Line 48

  12. Your answer: admin password

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

    Line 49

  13. Auto-generated app secret

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

    Line 50

  14. Where the app's main data is saved

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

    Line 53

  15. Where add-ons and plugins is saved

    Where add-ons and plugins is saved on your server: App storage (fast) › kimai › plugins.

    Line 54

  16. Where the app's database is saved

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

    Line 55

  17. Web port: 30237

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

    Line 58

  18. 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 60