Skip to main content

Install

In this section you'll find a step-by-step guide to run your own production instance of Gmod Integration with Docker Swarm and Traefik.

Requirements​

Before you begin, make sure you have the following installed on your prod machine:

  • Docker
  • Git
  • Curl
  • A domain name
  • Cloudflare account (for Tunnel and Pages)

Fork 'gmod-integration-monorepo'​

To get started, you need to fork the 'gmod-integration-monorepo' repository on GitHub. This will create a copy of the repository under your own GitHub account, allowing you to make changes and deploy your own instance of Gmod Integration.

Clone and Prepare Environment​

git clone [email protected]:<your-account>/gmod-integration-monorepo.git
cd gmod-integration-monorepo
cp .env.example .env

Edit .env and set your production values.

Run the following commands to verify your environment variables are correctly set up:

CONFIG_ENV_FILE=.env bun -e "import '@gmod/config'; console.log('ENV API OK')"

CONFIG_ENV_FILE=.env bun -e "import '@gmod/config/website.js'; console.log('ENV WEBSITE OK')"

Deploy with Docker Swarm​

Initialize Swarm (once per host):

docker swarm init

Deploy stack:

./scripts/swarm-deploy.sh

Check services:

docker stack services gmod
docker service logs -f gmod_prisma-migrate

Create a full production backup:

bash ./scripts/swarm-backup.sh --all

For detailed Swarm operations (rollback, logs, troubleshooting), see Swarm Start Guide.

Swarm Automation (optional)​

Auto update from published images​

Use scripts/swarm-auto-update.sh to:

  1. Run git pull --ff-only on the repo (enabled by default)
  2. Pull configured images (API_IMAGE, WEBSOCKET_IMAGE, DISCORD_IMAGE from .env, with defaults to GHCR :latest)
  3. Compare local digest before/after pull
  4. Deploy stack only if at least one digest changed

If you want to skip repository updates:

./scripts/swarm-auto-update.sh --no-git-pull

Example:

./scripts/swarm-auto-update.sh --env-file .env --stack-name gmod

Cron example (backup + updater)​

See scripts/crontab.example for ready-to-adapt entries.

Cloudflare Tunnels​

To protect your environment, use Cloudflare Tunnel to expose only Traefik.

In Swarm mode, do not route directly to 53136 / 53139. Both API and WebSocket FQDNs should target local Traefik (localhost:80), and Traefik will dispatch by hostname.

ProtocolLocal EndpointPublic Endpoint
httplocalhost:80api.your-domain.com
httplocalhost:80ws.your-domain.com
httplocalhost:80traefik.your-domain.com

Cloudflare Pages (Frontend)​

The docs & website are static sites, so we can use Cloudflare Pages to host them. This is a free service that allows us to deploy our static sites with ease.

To set up Cloudflare Pages, follow these steps:

  1. Go to the Cloudflare dashboard and select your account.
  2. Click on "Pages" in the left-hand menu.
  3. Click on "Create a Project" and connect your GitHub repository fork of 'gmod-integration-monorepo'.
  4. Select the branch you want to deploy (e.g., main).
  5. Configure the build settings:
    • Build command: bun install && bunx turbo run build --filter=@gmod/app-website
    • Build output directory: apps/website/dist
  6. Click "Save and Deploy" to start the deployment process.
  7. Once the deployment is complete, you will receive a URL where your docs are hosted. You can also set up a custom domain if you have one.

Login to Dashboard​

Now everything is set up, you can log in to your dashboard using discord, make the bot join your discord server, and create a server for it to connect to, get the ID & Token, and add them in your environment variables to allow your Garry's Mod server to connect to your instance of Gmod Integration.

Just like a normal install of Gmod Integration see documentation

Edit In Game Configuration​

Now you have a self hosted instance of Gmod Integration, you need to change the FQDN to use by yours Garry's Mod server to connect to your instance instead of the public one.

Go in your console and type the following command, replacing your-domain.com with the domain you set up for your Cloudflare Pages:

gmod-integration config set apiFQDN "https://api.your-domain.com"
gmod-integration config set websocketFQDN "https://ws.your-domain.com"