Hexy Templates

Teamspeak

TeamSpeak is software for quality voice communication via the Internet.

Not yet tested productivity Based on TrueNAS app v1.1.8 (Teamspeak 3.13.8)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Teamspeak and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
teamspeak.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS teamspeak 1.1.8"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [9987, 30033, 10011, 10022]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/teamspeak"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/teamspeak/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    }
21  ],
22  "app_values": {
23    "storage": {
824      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/teamspeak/data)"
25    },
26    "network": {
927      "voice_port": {"bind_mode": "published", "port_number": 9987},
1028      "file_transfer_port": {
29        "bind_mode": "published",
30        "port_number": 30033
31      },
1132      "raw_query_port": {"bind_mode": "published", "port_number": 10011},
1233      "ssh_query_port": {"bind_mode": "published", "port_number": 10022}
34    },
1335    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
36  }
37}

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 teamspeak 1.1.8”.

    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 ports 9987, 30033, 10011 and 10022 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) › teamspeak and App storage (fast) › teamspeak › 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–21

  8. Where the app's main data is saved

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

    Line 24

  9. Voice port: 9987

    Publishes the app's voice port as 9987.

    Line 27

  10. File transfer port: 30033

    Publishes the app's file transfer port as 30033.

    Lines 28–31

  11. Raw query port: 10011

    Publishes the app's raw query port as 10011.

    Line 32

  12. Ssh query port: 10022

    Publishes the app's ssh query port as 10022.

    Line 33

  13. 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 35