Hexy Templates

Gaseous Server

This is the server for the Gaseous system. It offers ROM and title management, as well as some basic in browser emulation of those ROMs.

Not yet tested games Based on TrueNAS app v1.3.9 (Gaseous Server v1.7.14)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Gaseous Server and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
gaseous-server.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS gaseous-server 1.3.9"
6  },
37  "installation_questions": [
8    {
9      "question": "Igdb client id",
10      "type": "text",
11      "key": "igdb_client_id",
12      "required": true
13    },
14    {
15      "question": "Igdb client secret",
16      "type": "password",
17      "key": "igdb_client_secret",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [5198]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/gaseous-server"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/gaseous-server/mariadb_data",
32      "owner": {"user": "netdata", "group": "docker"},
33      "snapshot": {"id": "mariadb_data"}
34    },
35    {
36      "path": "$LOCATION(ApplicationsPerformance)/gaseous-server/data",
37      "snapshot": {"id": "data"}
38    }
39  ],
40  "app_values": {
41    "gaseous": {
942      "db_password": "$RANDOM_STRING(16)",
1043      "db_root_password": "$RANDOM_STRING(16)",
1144      "igdb_client_id": "$QUESTION(igdb_client_id)",
1245      "igdb_client_secret": "$QUESTION(igdb_client_secret)"
46    },
47    "storage": {
1348      "mariadb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/gaseous-server/mariadb_data)",
1449      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/gaseous-server/data)"
50    },
51    "network": {
1552      "web_port": {"bind_mode": "published", "port_number": 5198}
53    },
1654    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
55  }
56}

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 gaseous-server 1.3.9”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Igdb client id and Igdb client secret. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–20

  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 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

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

    Line 24

  7. Network ports

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

    Line 25

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › gaseous-server, App storage (fast) › gaseous-server › mariadb_data and App storage (fast) › gaseous-server › 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 27–39

  9. Auto-generated db password

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

    Line 42

  10. Auto-generated db root password

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

    Line 43

  11. Your answer: igdb client id

    Filled in with what you typed for “igdb client id” when you installed.

    Line 44

  12. Your answer: igdb client secret

    Filled in with what you typed for “igdb client secret” when you installed.

    Line 45

  13. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › gaseous-server › mariadb_data.

    Line 48

  14. Where the app's main data is saved

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

    Line 49

  15. Web port: 5198

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

    Line 52

  16. 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 54