Hexy Templates

Invoice Ninja

Invoices, Expenses and Tasks built with Laravel, Flutter and React

Not yet tested productivity Based on TrueNAS app v1.2.25 (Invoice Ninja 5.12.28-o)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Invoice Ninja and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
invoice-ninja.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS invoice-ninja 1.2.25"
6  },
37  "installation_questions": [
8    {
9      "question": "Initial user email",
10      "type": "text",
11      "key": "initial_user_email",
12      "required": true
13    },
14    {
15      "question": "Initial user password",
16      "type": "password",
17      "key": "initial_user_password",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [31105]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/invoice-ninja"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/invoice-ninja/storage",
32      "snapshot": {"id": "storage"}
33    },
34    {
35      "path": "$LOCATION(ApplicationsPerformance)/invoice-ninja/mariadb_data",
36      "owner": {"user": "netdata", "group": "docker"},
37      "snapshot": {"id": "mariadb_data"}
38    }
39  ],
40  "app_values": {
41    "invoice_ninja": {
942      "db_password": "$RANDOM_STRING(16)",
1043      "db_root_password": "$RANDOM_STRING(16)",
1144      "redis_password": "$RANDOM_STRING(16)",
1245      "app_key": "$RANDOM_STRING(32)",
1346      "initial_user_email": "$QUESTION(initial_user_email)",
1447      "initial_user_password": "$QUESTION(initial_user_password)"
48    },
49    "storage": {
1550      "storage": "$HOST_PATH($LOCATION(ApplicationsPerformance)/invoice-ninja/storage)",
1651      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/invoice-ninja/mariadb_data)"
52    },
53    "network": {
1754      "web_port": {"bind_mode": "published", "port_number": 31105}
55    },
1856    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
57  }
58}

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 invoice-ninja 1.2.25”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Initial user email and Initial user 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 31105 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) › invoice-ninja, App storage (fast) › invoice-ninja › storage and App storage (fast) › invoice-ninja › 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–39

  9. Auto-generated db password

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

    Line 42

  10. Auto-generated db root password

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

    Line 43

  11. Auto-generated redis password

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

    Line 44

  12. Auto-generated app key

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

    Line 45

  13. Your answer: initial user email

    Filled in with what you typed for “initial user email” when you installed.

    Line 46

  14. Your answer: initial user password

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

    Line 47

  15. Where the app's “storage” files is saved

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

    Line 50

  16. Where the app's database is saved

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

    Line 51

  17. Web port: 31105

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

    Line 54

  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 56