Hexy Templates

Calagopus

A modern game server management panel built in Rust. Deploy, monitor, and manage Minecraft, Hytale, and other game servers with industry-leading performance.

Not yet tested games Based on TrueNAS app v1.0.36 (Calagopus 1.2.3-aio)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Calagopus and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
calagopus.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS calagopus 1.0.36"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30438, 30439]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/calagopus"},
16    {"path": "$LOCATION(ApplicationsCapacity)"},
17    {"path": "$LOCATION(ApplicationsCapacity)/calagopus"},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/calagopus/data",
20      "snapshot": {"id": "data"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/calagopus/wings_data",
24      "snapshot": {"id": "wings_data"}
25    },
26    {"path": "$LOCATION(ApplicationsCapacity)/calagopus/wings_temp"},
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/calagopus/binaries",
29      "snapshot": {"id": "binaries"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/calagopus/translations",
33      "snapshot": {"id": "translations"}
34    },
35    {
36      "path": "$LOCATION(ApplicationsPerformance)/calagopus/extensions",
37      "snapshot": {"id": "extensions"}
38    },
39    {
40      "path": "$LOCATION(ApplicationsPerformance)/calagopus/extension_migrations",
41      "snapshot": {"id": "extension_migrations"}
42    },
43    {
44      "path": "$LOCATION(ApplicationsPerformance)/calagopus/postgres_data",
45      "owner": {"user": "netdata", "group": "docker"},
46      "snapshot": {"id": "postgres_data"}
47    }
48  ],
49  "app_values": {
50    "calagopus": {
851      "db_password": "$RANDOM_STRING(16)",
952      "redis_password": "$RANDOM_STRING(16)",
1053      "encryption_key": "$RANDOM_STRING(32)"
54    },
55    "storage": {
1156      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/data)",
1257      "wings_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/wings_data)",
1358      "wings_temp": "$HOST_PATH($LOCATION(ApplicationsCapacity)/calagopus/wings_temp)",
1459      "binaries": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/binaries)",
1560      "translations": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/translations)",
1661      "extensions": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/extensions)",
1762      "extension_migrations": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/extension_migrations)",
1863      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/calagopus/postgres_data)"
64    },
65    "network": {
1966      "web_port": {"bind_mode": "published", "port_number": 30438},
2067      "sftp_port": {"bind_mode": "published", "port_number": 30439}
68    },
2169    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
70  }
71}

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 calagopus 1.0.36”.

    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 ports 30438 and 30439 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) › calagopus, App storage (large) › calagopus, App storage (fast) › calagopus › data, App storage (fast) › calagopus › wings_data, App storage (large) › calagopus › wings_temp, App storage (fast) › calagopus › binaries, App storage (fast) › calagopus › translations, App storage (fast) › calagopus › extensions, App storage (fast) › calagopus › extension_migrations and App storage (fast) › calagopus › 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–48

  8. Auto-generated db password

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

    Line 51

  9. Auto-generated redis password

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

    Line 52

  10. Auto-generated encryption key

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

    Line 53

  11. Where the app's main data is saved

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

    Line 56

  12. Where the app's “wings data” files is saved

    Where the app's “wings data” files is saved on your server: App storage (fast) › calagopus › wings_data.

    Line 57

  13. Where the app's “wings temp” files is saved

    Where the app's “wings temp” files is saved on your server: App storage (large) › calagopus › wings_temp.

    Line 58

  14. Where the app's “binaries” files is saved

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

    Line 59

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

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

    Line 60

  16. Where the app's “extensions” files is saved

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

    Line 61

  17. Where the app's “extension migrations” files is saved

    Where the app's “extension migrations” files is saved on your server: App storage (fast) › calagopus › extension_migrations.

    Line 62

  18. Where the app's database is saved

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

    Line 63

  19. Web port: 30438

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

    Line 66

  20. Sftp port: 30439

    Publishes the app's sftp port as 30439.

    Line 67

  21. 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 69