Hexy Templates

OpenUEM Server

An Open-Source Unified Endpoint Manager that is self-hosted and lets you manage your IT assets thanks to its agents

Not yet tested monitoring Based on TrueNAS app v1.0.37 (OpenUEM Server 0.12.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 OpenUEM Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
openuem.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS openuem 1.0.37"
6  },
37  "installation_questions": [
8    {
9      "question": "Domain",
10      "type": "text",
11      "key": "domain",
12      "required": true
13    },
14    {
15      "question": "Org name",
16      "type": "text",
17      "key": "org_name",
18      "required": true
19    },
20    {
21      "question": "Org province",
22      "type": "text",
23      "key": "org_province",
24      "required": true
25    },
26    {
27      "question": "Org locality",
28      "type": "text",
29      "key": "org_locality",
30      "required": true
31    },
32    {
33      "question": "Org address",
34      "type": "text",
35      "key": "org_address",
36      "required": true
37    },
38    {
39      "question": "Org country",
40      "type": "text",
41      "key": "org_country",
42      "required": true
43    }
44  ],
45  "requirements": {
446    "locations": ["ApplicationsPerformance"],
547    "specifications": ["2CORE"],
648    "permissions": ["READ_WRITE_LOCATIONS"],
749    "ports": [30400, 30401, 30402, 30403]
50  },
851  "ensure_directories_exists": [
52    {"path": "$LOCATION(ApplicationsPerformance)"},
53    {"path": "$LOCATION(ApplicationsPerformance)/openuem"},
54    {
55      "path": "$LOCATION(ApplicationsPerformance)/openuem/nats_data",
56      "snapshot": {"id": "nats_data"}
57    },
58    {
59      "path": "$LOCATION(ApplicationsPerformance)/openuem/certificates",
60      "snapshot": {"id": "certificates"}
61    },
62    {
63      "path": "$LOCATION(ApplicationsPerformance)/openuem/postgres_data",
64      "owner": {"user": "netdata", "group": "docker"},
65      "snapshot": {"id": "postgres_data"}
66    }
67  ],
68  "app_values": {
69    "openuem": {
970      "postgres_password": "$RANDOM_STRING(16)",
1071      "jwt_key": "$RANDOM_STRING(32)",
1172      "domain": "$QUESTION(domain)",
1273      "org_name": "$QUESTION(org_name)",
1374      "org_province": "$QUESTION(org_province)",
1475      "org_locality": "$QUESTION(org_locality)",
1576      "org_address": "$QUESTION(org_address)",
1677      "org_country": "$QUESTION(org_country)"
78    },
79    "storage": {
1780      "nats_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openuem/nats_data)",
1881      "certificates": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openuem/certificates)",
1982      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/openuem/postgres_data)"
83    },
84    "network": {
2085      "web_port": {"bind_mode": "published", "port_number": 30400},
2186      "auth_port": {"bind_mode": "published", "port_number": 30401},
2287      "ocsp_port": {"bind_mode": "published", "port_number": 30402},
2388      "nats_port": {"bind_mode": "published", "port_number": 30403}
89    },
2490    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
91  }
92}

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 openuem 1.0.37”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Domain, Org name, Org province, Org locality, Org address and Org country. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–44

  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 46

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 47

  6. Permission to use your folders

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

    Line 48

  7. Network ports

    The app needs ports 30400, 30401, 30402 and 30403 to be free on your server. A port is like an apartment number for your server's address.

    Line 49

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › openuem, App storage (fast) › openuem › nats_data, App storage (fast) › openuem › certificates and App storage (fast) › openuem › 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 51–67

  9. Auto-generated postgres password

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

    Line 70

  10. Auto-generated jwt key

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

    Line 71

  11. Your answer: domain

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

    Line 72

  12. Your answer: org name

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

    Line 73

  13. Your answer: org province

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

    Line 74

  14. Your answer: org locality

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

    Line 75

  15. Your answer: org address

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

    Line 76

  16. Your answer: org country

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

    Line 77

  17. Where the app's “nats data” files is saved

    Where the app's “nats data” files is saved on your server: App storage (fast) › openuem › nats_data.

    Line 80

  18. Where the app's “certificates” files is saved

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

    Line 81

  19. Where the app's database is saved

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

    Line 82

  20. Web port: 30400

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

    Line 85

  21. Auth port: 30401

    Publishes the app's auth port as 30401.

    Line 86

  22. Ocsp port: 30402

    Publishes the app's ocsp port as 30402.

    Line 87

  23. Nats port: 30403

    Publishes the app's nats port as 30403.

    Line 88

  24. 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 90