Server setup
GameVault Server runs on any machine with Docker, or natively on Linux. Pick the guide that matches your host. Every method uses the same image and the same configuration variables.
You need a host with at least 2 GB of RAM, a folder for game files and a database. PostgreSQL is recommended for larger libraries; SQLite works for small setups.
Supported methods
| Host | Guide | Notes |
|---|---|---|
| Docker Compose | Docker Compose | Recommended for most Linux hosts and VPS |
| CapRover | CapRover | Managed Docker host with a web UI |
| TrueNAS SCALE 24.10 or newer | TrueNAS SCALE | Uses the Docker-compatible app system |
| Unraid | Unraid | Community Applications template |
| Synology Container Manager | Synology Container Manager | DSM 7.2 or newer |
| Linux without Docker | Native installation | Node.js and PostgreSQL or SQLite |
If you have trouble, ask on Discord. Include your host, the method you used and the server logs.
Add more setup guides
GameVault runs on more systems than we can test. If you set it up on a NAS or a platform that is missing here, a documentation pull request is welcome: gamevault-docs.
What next?
Once the server is running, open http://<server-ip>:8080 in a browser. The
Web UI is GameVault 2 and needs no installation. Disable it with
WEB_UI_ENABLED=false if you only want to serve the API.
- Configure the server. Review the configuration reference.
- Add games. Prepare the file and folder structure, then add your games.
- Create the first user. The first registered account is activated automatically and receives the admin role. See user management.
- Add metadata. Connect a provider such as IGDB.
- Expose the server. For access outside your LAN, use an HTTPS reverse proxy and review Fail2Ban.