Hexy Templates

GameVault

The self-hosted gaming platform for your DRM-free collection. Host your own library, track your stats, and share the experience with friends. It's like having your own personal Steam, but you're the one in control

Not yet tested games Based on TrueNAS app v1.0.21 (GameVault 17.0.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find GameVault and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
game-vault.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS game-vault 1.0.21"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30419, 30420]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/game-vault"},
16    {"path": "$LOCATION(Media)", "network_share": true},
17    {
18      "path": "$LOCATION(ApplicationsPerformance)/game-vault/config",
19      "owner": {"user": "apps"},
20      "snapshot": {"id": "config"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/game-vault/savefiles",
24      "owner": {"user": "apps"},
25      "snapshot": {"id": "savefiles"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/game-vault/files",
29      "owner": {"user": "apps"},
30      "snapshot": {"id": "files"}
31    },
32    {
33      "path": "$LOCATION(ApplicationsPerformance)/game-vault/plugins",
34      "owner": {"user": "apps"},
35      "snapshot": {"id": "plugins"}
36    },
37    {
38      "path": "$LOCATION(ApplicationsPerformance)/game-vault/postgres_data",
39      "owner": {"user": "netdata", "group": "docker"},
40      "snapshot": {"id": "postgres_data"}
41    }
42  ],
43  "app_values": {
844    "game_vault": {"db_password": "$RANDOM_STRING(16)"},
45    "storage": {
946      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/game-vault/config)",
1047      "media": "$HOST_PATH($LOCATION(Media))",
1148      "savefiles": "$HOST_PATH($LOCATION(ApplicationsPerformance)/game-vault/savefiles)",
1249      "files": "$HOST_PATH($LOCATION(ApplicationsPerformance)/game-vault/files)",
1350      "plugins": "$HOST_PATH($LOCATION(ApplicationsPerformance)/game-vault/plugins)",
1451      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/game-vault/postgres_data)"
52    },
53    "network": {
1554      "http_port": {"bind_mode": "published", "port_number": 30419},
1655      "https_port": {"bind_mode": "published", "port_number": 30420}
56    },
1757    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
58  }
59}

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 game-vault 1.0.21”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and Media. 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 30419 and 30420 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) › game-vault, App storage (fast) › game-vault › config, App storage (fast) › game-vault › savefiles, App storage (fast) › game-vault › files, App storage (fast) › game-vault › plugins and App storage (fast) › game-vault › 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–42

  8. Auto-generated db password

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

    Line 44

  9. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › game-vault › config.

    Line 46

  10. Where your media is saved

    Where your media is saved on your server: Media.

    Line 47

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

    Where the app's “savefiles” files is saved on your server: App storage (fast) › game-vault › savefiles.

    Line 48

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

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

    Line 49

  13. Where add-ons and plugins is saved

    Where add-ons and plugins is saved on your server: App storage (fast) › game-vault › plugins.

    Line 50

  14. Where the app's database is saved

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

    Line 51

  15. Http port: 30419

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

    Line 54

  16. Https port: 30420

    Publishes the app's https port as 30420.

    Line 55

  17. 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 57