Repository navigation
Installation
Step-by-step install guide for the GSBS server and client on all supported platforms.
The server is a single Go binary backed by SQLite. The recommended deployment is Docker Compose with Caddy for automatic TLS.
Production deployment with Caddy TLS reverse proxy and auto-HTTPS:
git clone https://github.com/dlommm/GSBS-Game-Sync-Backup-Service.git
cd GSBS-Game-Sync-Backup-Service
docker compose up -dGSBS starts with no required configuration: it generates its own session secret into the data volume and opens a browser setup wizard where you create the admin account (the first user is the administrator) and choose registration/storage/backup options. Copy .env.example to .env only to pin optional overrides.
Edit docs/Caddyfile with your domain before exposing to the internet. For full Compose options (health checks, TLS alternatives, nginx, Traefik) see Server Configuration.
Security: the setup wizard is open only until the first account is created and locks 60 minutes after startup. Complete it promptly and don't leave an un-configured instance exposed.
Local development (plain HTTP on port 8080, no TLS):
docker compose -f docker-compose.dev.yml up --builddocker pull dendlomm/gsbs-server:latest
docker run -d \
-p 8080:8080 \
-e GSBS_DB="/app/data/gsbs.db" \
-v gsbs-data:/app/data \
dendlomm/gsbs-server:latestDownload gsbs-server-linux-amd64 or gsbs-server-windows-amd64.exe from GitHub Releases, then:
export GSBS_DB="/path/to/gsbs.db"
./gsbs-server-linux-amd64
# then open the printed address and complete the setup wizard- Download
gsbs-server-setup-X.Y.Z-windows-amd64.exefrom GitHub Releases. - Run the installer as Administrator.
- In the installer, set
GSBS_DBand the port; the session secret is generated automatically (or setGSBS_SESSION_SECRETto pin one). - By default, leave Install and run GSBS Server as a Windows Service (recommended) enabled.
- Finish install and optionally open GSBS Admin in your browser.
The installer writes runtime config to C:\ProgramData\GSBS\server.env, installs binaries to C:\Program Files\GSBS, and stores launcher logs under C:\ProgramData\GSBS\logs. Uninstall removes installed binaries and the GSBS Server Windows Service, but keeps ProgramData config/database by default.
| Component | linux/amd64 | linux/arm64 | windows/amd64 |
|---|---|---|---|
| Server | Yes | Yes (Docker only) | Binary only |
| Client | Yes | No | Yes |
Note: macOS is not officially supported. The server may build from source on macOS for development, but is not tested or released for it.
Download client assets from the latest GitHub Release.
- Download
gsbs-client-setup-X.Y.Z-windows-amd64.exe. - Run the installer. If Windows SmartScreen shows a warning, click More info → Run anyway (installers are not code-signed yet — see note below).
- Optional: enable Run at startup during install.
- Launch GSBS Client from the Start Menu or system tray.
SmartScreen note: Windows may warn about unsigned executables. Download only from the official GitHub Releases page and verify the SHA256 checksum in
SHA256SUMSif you want extra assurance.
Auto-update: The tray menu checks GitHub Releases daily. Use Install update… to update without re-running the installer.
flatpak remote-add --if-not-exists gsbs \
https://dlommm.github.io/gsbs-flatpak/repo/gsbs.flatpakrepo
flatpak install gsbs io.github.dlommm.GSBS
flatpak run io.github.dlommm.GSBSUpdates arrive via flatpak update or your software center (the in-app self-updater is intentionally disabled in the sandbox). The sandbox grants access to the home folder, the default Steam/Heroic/Lutris/Bottles data locations, and SD cards under /run/media; for a Steam library on another internal drive, grant access with:
flatpak override --user io.github.dlommm.GSBS --filesystem=/path/to/SteamLibrarySee FLATPAK.md for the Steam Deck Desktop-Mode walkthrough, the full permission list, and Flatseal guidance.
sudo apt install ./gsbs-client_X.Y.Z_amd64.deb # resolves the xdg-utils dependency
gsbs-client # or launch from your application menuGNOME: install the AppIndicator and KStatusNotifierItem Support extension so the tray icon shows. No appindicator libraries are needed — the tray is pure-Go D-Bus.
chmod +x gsbs-client-X.Y.Z-x86_64.AppImage
./gsbs-client-X.Y.Z-x86_64.AppImageRequires AppIndicator/status notifier support on your desktop environment:
| Desktop | Status |
|---|---|
| KDE Plasma | Works out of the box |
| Xfce | Works out of the box |
| GNOME | Requires a tray extension (e.g. AppIndicator and KStatusNotifierItem Support) |
| Cinnamon | Works out of the box |
chmod +x gsbs-client-linux-amd64
./gsbs-client-linux-amd64After server and client are installed:
- Open the server WebUI (e.g.
https://your-domainorhttp://localhost:8080). On a fresh server the setup wizard appears automatically. - Complete the wizard: create the admin account (the first user is the administrator) and choose registration/storage/backup options.
- On the client, open the tray menu → Login…. Enter the server URL and your credentials.
- GSBS stores the token in
config.jsonand starts syncing. Use Sync now or Open local status from the tray to verify.
Config and logs are stored in:
-
Windows:
%APPDATA%\gsbs\ -
Linux:
~/.config/gsbs/
| Direction | Port | Protocol | Purpose |
|---|---|---|---|
| Clients → Server | 443 (HTTPS) or 8080 (HTTP) | TCP | API, WebUI |
| Clients → Server | 443 or 8080 | TCP | SSE event stream |
No inbound ports are needed on client machines. The server must be reachable by all clients.
Set in config.json to disable daily update checks:
{
"update_check_enabled": false
}To point at a fork or mirror instead:
{
"update_repo": "your-org/your-fork"
}See the Unraid deployment guide and the example compose-unraid.yml.
Getting started
Reference
Help
Contributing