Hexy Templates

OpenArchiver

An open-source platform for legally compliant email archiving.

Not yet tested productivity Based on TrueNAS app v1.2.69 (OpenArchiver v0.6.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 OpenArchiver and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
openarchiver.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS openarchiver 1.2.69"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30288]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/openarchiver"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/openarchiver/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/openarchiver/meili_data",
23      "owner": {"user": "apps"},
24      "snapshot": {"id": "meili_data"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/openarchiver/postgres_data",
28      "owner": {"user": "netdata", "group": "docker"},
29      "snapshot": {"id": "postgres_data"}
30    }
31  ],
32  "app_values": {
33    "openarchiver": {
834      "db_password": "$RANDOM_STRING(16)",
935      "redis_password": "$RANDOM_STRING(16)",
1036      "meilisearch_master_key": "$RANDOM_STRING(32)",
1137      "encryption_key": "$RANDOM_STRING(32)",
1238      "jwt_secret": "$RANDOM_STRING(32)",
1339      "app_url": "http://$SERVER_LAN_IP:30288"
40    },
41    "storage": {
1442      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openarchiver/data)",
1543      "meili_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openarchiver/meili_data)",
1644      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openarchiver/postgres_data)"
45    },
46    "network": {
1747      "web_port": {"bind_mode": "published", "port_number": 30288}
48    },
1849    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
50  }
51}

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 openarchiver 1.2.69”.

    Lines 3–6

  3. 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 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 30288 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) › openarchiver, App storage (fast) › openarchiver › data, App storage (fast) › openarchiver › meili_data and App storage (fast) › openarchiver › 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–31

  8. Auto-generated db password

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

    Line 34

  9. Auto-generated redis password

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

    Line 35

  10. Auto-generated meilisearch master key

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

    Line 36

  11. Auto-generated encryption key

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

    Line 37

  12. Auto-generated jwt secret

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

    Line 38

  13. Your server's address (app url)

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

    Line 39

  14. Where the app's main data is saved

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

    Line 42

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

    Where the app's “meili data” files is saved on your server: App storage (fast) › openarchiver › meili_data.

    Line 43

  16. Where the app's database is saved

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

    Line 44

  17. Web port: 30288

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

    Line 47

  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 49