Sign inSign up

dendlomm/gsbs-server

By dendlomm

โ€ขUpdated 25 days ago

Image
0

6.9K

dendlomm/gsbs-server repository overview

GSBS โ€” Game Sync & Backup Service โ 

๐Ÿš€ GSBS v4 โ€” Major release
Zero-config setup wizard ยท game-aware sync (pause while playing) ยท built-in offsite backups + one-command restore ยท notifications ยท save export/import ยท end-to-end encryption upgraded to Argon2id ยท macOS + arm64 clients

โ GSBS Server

GSBSโ  (Game Sync & Backup Service) keeps game saves in sync across your PCs. This image runs the central server only. Install the Windows/Linux client from GitHub Releasesโ  on each gaming machine.

Clients watch save folders, upload on change, and pull existing saves when a game is installed. The server stores one current save per user per game path, serves a PCGamingWiki-based location manifest, and provides a WebUI for registration, tokens, and admin.

โ What's new in v3

Manifest ready in minutes, not days. Fresh Docker installs default to S3 manifest bundle sync โ€” a pre-built PCGamingWiki snapshot hosted on public object storage (Cloudflare R2, S3-compatible). On first start the server downloads the full catalog (~40k+ games) in one fetch instead of crawling the PCGW API page-by-page, which previously took days on a new server.

Far fewer PCGW API calls. Routine updates fetch a small index.json version pointer first. When nothing changed, ETag/304 Not Modified exits in seconds with zero bundle download and no PCGW traffic. When a new version is published, the server applies only what changed via smart merge โ€” reducing load on both your server and PCGamingWiki.

Other v3 highlights:

  • Encrypted save dedup โ€” unchanged encrypted saves no longer re-upload every sync cycle
  • First-push overwrite guard โ€” prevents a fresh client from silently clobbering another machine's save
  • Crash-safe canonical saves โ€” atomic disk writes when using GSBS_SAVE_ROOT
  • Client manifest pagination (3.0.1) โ€” full catalog download for large game libraries

Switch sync mode anytime in Admin โ†’ Settings (s3 bundle vs direct PCGW API). See docs/MANIFEST_BUNDLE.mdโ .

โ What's in this image

  • REST API and embedded WebUI
  • SQLite persistence (users, saves, manifest, job history)
  • S3 manifest bundle sync (default) or scheduled direct PCGW sync
  • Versioned bundle index with ETag-aware fetch and smart merge import
  • Health endpoint: GET /api/health (optional ?ready=1 for DB readiness)
  • Runs as non-root user gsbs (UID 1000); entrypoint fixes /app/data volume ownership on startup

Platforms: linux/amd64, linux/arm64

Tags: latest and semver without v (example 3.0.1). Match GitHub Releasesโ .

โ Quick start

docker pull dendlomm/gsbs-server:latest

docker run -d \
  --name gsbs \
  --restart unless-stopped \
  -p 8080:8080 \
  -e GSBS_SESSION_SECRET="$(openssl rand -hex 32)" \
  -e GSBS_DB=/app/data/gsbs.db \
  -v gsbs-data:/app/data \
  dendlomm/gsbs-server:latest

On first boot the server fetches the PCGW manifest bundle automatically โ€” clients can search and sync games within minutes.

โ Server

Open http://localhost:8080, register, create an API token, and point the client at your server URL.

Production: Put TLS in front (Caddy, Nginx, or Traefik). The repo includes docker-compose.ymlโ  (server + Caddy). See docs/COMPOSE.mdโ .

โ Persistence

Mount a volume at /app/data and set GSBS_DB=/app/data/gsbs.db. All state (users, saves, manifest) lives in that SQLite file and survives container recreation.

โ Important environment variables

VariableNotes
GSBS_SESSION_SECRETRequired in production. Signs WebUI session cookies.
GSBS_DBDatabase path. Use /app/data/gsbs.db with a volume.
GSBS_ADDRListen address (default :8080).
GSBS_PCGW_SYNC_SOURCEs3 (default, manifest bundle) or api (direct PCGW crawl).
GSBS_PCGW_BUNDLE_URLFull bundle URL (default: official CDN).
GSBS_PCGW_BUNDLE_INDEX_URLVersion index URL (auto-derived from bundle URL if unset).
GSBS_PCGW_BUNDLE_CRONBundle fetch schedule when source is s3 (default daily 04:00).
GSBS_ADMIN_USERNAMERestrict /admin to one user.
GSBS_READ_ONLYSet to true to disable push and delete.
GSBS_MAX_STORAGE_BYTESOptional global storage cap.

Full list: docs/DOCKER.mdโ 

โ Architecture

        +---------------------------+
        |   gsbs-server (this)      |
        |  API + WebUI + SQLite     |
        |  โ† S3 manifest bundle     |
        +-------------+-------------+
                      |
        +-------------+-------------+
        v             v             v
   gsbs-client   gsbs-client       ...
    (Windows)      (Linux)

โ Documentation

โ License

MIT โ€” LICENSEโ 

Tag summary

Content type

Image

Digest

sha256:e1d8002b0โ€ฆ

Size

20.9 MB

Last updated

25 days ago

docker pull dendlomm/gsbs-server