Hexy Templates

Steam Headless

A Headless Steam Docker image supporting NVIDIA GPU and accessible via Web UI

Not yet tested games Based on TrueNAS app v1.1.9 (Steam Headless debian)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Steam Headless and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
steam-headless.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS steam-headless 1.1.9"
6  },
37  "installation_questions": [
8    {
9      "question": "User password",
10      "type": "password",
11      "key": "user_password",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [31100]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/steam-headless"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/steam-headless/home",
26      "snapshot": {"id": "home"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsPerformance)/steam-headless/games",
30      "snapshot": {"id": "games"}
31    },
32    {
33      "path": "$LOCATION(ApplicationsPerformance)/steam-headless/x11_socket",
34      "snapshot": {"id": "x11_socket"}
35    },
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/steam-headless/pulse_socket",
38      "snapshot": {"id": "pulse_socket"}
39    }
40  ],
41  "app_values": {
942    "steam_headless": {"user_password": "$QUESTION(user_password)"},
43    "storage": {
1044      "home": "$HOST_PATH($LOCATION(ApplicationsPerformance)/steam-headless/home)",
1145      "games": "$HOST_PATH($LOCATION(ApplicationsPerformance)/steam-headless/games)",
1246      "x11_socket": "$HOST_PATH($LOCATION(ApplicationsPerformance)/steam-headless/x11_socket)",
1347      "pulse_socket": "$HOST_PATH($LOCATION(ApplicationsPerformance)/steam-headless/pulse_socket)"
48    },
49    "network": {
1450      "vnc_port": {"bind_mode": "published", "port_number": 31100}
51    },
1552    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
53  }
54}

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 steam-headless 1.1.9”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: User password. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  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 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › steam-headless, App storage (fast) › steam-headless › home, App storage (fast) › steam-headless › games, App storage (fast) › steam-headless › x11_socket and App storage (fast) › steam-headless › pulse_socket. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 21–40

  9. Your answer: user password

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

    Line 42

  10. Where the app's “home” files is saved

    Where the app's “home” files is saved on your server: App storage (fast) › steam-headless › home.

    Line 44

  11. Where the app's “games” files is saved

    Where the app's “games” files is saved on your server: App storage (fast) › steam-headless › games.

    Line 45

  12. Where the app's “x11 socket” files is saved

    Where the app's “x11 socket” files is saved on your server: App storage (fast) › steam-headless › x11_socket.

    Line 46

  13. Where the app's “pulse socket” files is saved

    Where the app's “pulse socket” files is saved on your server: App storage (fast) › steam-headless › pulse_socket.

    Line 47

  14. Vnc port: 31100

    Publishes the app's vnc port as 31100.

    Line 50

  15. 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 52