Hexy Templates

Mumble

Mumble is a free, open source, low latency, high quality voice chat application.

Not yet tested productivity Based on TrueNAS app v1.4.8 (Mumble v1.6.870)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Mumble and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
mumble.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS mumble 1.4.8"
6  },
37  "installation_questions": [
8    {
9      "question": "Superuser password",
10      "type": "password",
11      "key": "superuser_password",
12      "required": true
13    },
14    {
15      "question": "Server password",
16      "type": "password",
17      "key": "server_password",
18      "required": true
19    },
20    {
21      "question": "Welcome text",
22      "type": "text",
23      "key": "welcome_text",
24      "required": true
25    },
26    {
27      "question": "Users",
28      "type": "number",
29      "key": "users",
30      "required": true
31    }
32  ],
33  "requirements": {
434    "locations": ["ApplicationsPerformance"],
535    "specifications": ["2CORE"],
636    "permissions": ["READ_WRITE_LOCATIONS"],
737    "ports": [30018, 30019]
38  },
839  "ensure_directories_exists": [
40    {"path": "$LOCATION(ApplicationsPerformance)"},
41    {"path": "$LOCATION(ApplicationsPerformance)/mumble"},
42    {
43      "path": "$LOCATION(ApplicationsPerformance)/mumble/data",
44      "snapshot": {"id": "data"}
45    }
46  ],
47  "app_values": {
48    "mumble": {
949      "superuser_password": "$QUESTION(superuser_password)",
1050      "server_password": "$QUESTION(server_password)",
1151      "ice_secret_read": "$RANDOM_STRING(32)",
1252      "ice_secret_write": "$RANDOM_STRING(32)",
1353      "welcome_text": "$QUESTION(welcome_text)",
1454      "users": "$QUESTION(users)"
55    },
56    "storage": {
1557      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/mumble/data)"
58    },
59    "network": {
1660      "server_port": {"bind_mode": "published", "port_number": 30018},
1761      "ice_port": {"bind_mode": "published", "port_number": 30019}
62    },
1863    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
64  }
65}

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 mumble 1.4.8”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Superuser password, Server password, Welcome text and Users. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–32

  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 34

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 35

  6. Permission to use your folders

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

    Line 36

  7. Network ports

    The app needs ports 30018 and 30019 to be free on your server. A port is like an apartment number for your server's address.

    Line 37

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › mumble and App storage (fast) › mumble › data. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 39–46

  9. Your answer: superuser password

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

    Line 49

  10. Your answer: server password

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

    Line 50

  11. Auto-generated ice secret read

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

    Line 51

  12. Auto-generated ice secret write

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

    Line 52

  13. Your answer: welcome text

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

    Line 53

  14. Your answer: users

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

    Line 54

  15. Where the app's main data is saved

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

    Line 57

  16. Server port: 30018

    Publishes the app's server port as 30018.

    Line 60

  17. Ice port: 30019

    Publishes the app's ice port as 30019.

    Line 61

  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 63