Backup

GES keeps documentation catalogs in GitLab, so GitLab backs them up. The database, settings, portal data and AI service data stay on the GES server — back them up separately. Make backups regularly and always before an upgrade.

What is stored in GitLab

You don't need to copy this data separately — it is included in your GitLab backup:

  • Catalogs — repositories with articles.

  • GES settings with ENTERPRISE_STORAGE_TYPE=gitlab — space, user and access settings files in the GIT_PROJECT_PATH repository.

Make sure GitLab backup is set up and includes these repositories.

What is stored on the server

In docker-compose.yaml, service data is kept in Docker volumes and in a folder next to the file:

  • enterprise-postgres-data — the postgres service volume. It holds the GES database: space metrics, training module results, access tokens.

  • enterprise-config — the enterprise service volume, folder /app/config. With ENTERPRISE_STORAGE_TYPE=local, it holds all GES settings.

  • ./docportal — the folder next to docker-compose.yaml, mounted to the docportal service. It holds the documentation portal data.

  • caddy_data and caddy_config — the caddy service volumes. They hold TLS certificates and the Caddy configuration.

  • ges-ai-qdrant-storage — the qdrant service volume, the vector database of AI features. Present if the ai profile is on.

  • ges-ai-api-storage — the ges-ai service volume, folder /app/storage. Present if the ai profile is on.

Besides service data, save the files in the installation folder:

  • .env — all variables: license key, tokens, COOKIE_SECRET, ENTERPRISE_SERVICE_ENCRYPTION_KEY, database password. Keep the copy in a secure place.

  • docker-compose.yaml — it contains your domains in the Caddy configuration and the variables you added to the environment sections.

  • custom-certs.pem, if you mounted your own root certificates.

Back up with Docker Compose

Run all commands in the folder with docker-compose.yaml.

  1. Save the database. You can run the command while GES is running:

    docker compose exec -T postgres sh -c 'pg_dump -U "$POSTGRES_USER" -d "$POSTGRES_DB"' > ges-db.sql
  2. Stop the services so that volume data does not change while copying:

    docker compose --profile ai stop
  3. Find the exact volume names. Docker Compose prefixes them with the project name — by default, the name of the folder with docker-compose.yaml:

    docker volume ls
  4. Archive each volume. Example for the enterprise-config volume in the ges project:

    docker run --rm -v ges_enterprise-config:/data -v "$PWD":/backup postgres:18-alpine \ tar czf /backup/enterprise-config.tar.gz -C /data .

    The example uses the postgres:18-alpine image because it is already on the server. Any image with tar works. Archive caddy_data, caddy_config and, if AI features are on, ges-ai-qdrant-storage and ges-ai-api-storage the same way.

  5. Archive the portal folder and the installation files:

    tar czf ges-files.tar.gz docportal .env docker-compose.yaml
  6. Start the services:

    docker compose --profile ai up -d

Without AI features, run the commands without --profile ai. Move the archives and ges-db.sql to separate storage.

Restore with Docker Compose

  1. Extract ges-files.tar.gz into the installation folder.

  2. Create the volumes and containers without starting them:

    docker compose --profile ai create
  3. Extract the archives into the volumes. Example for enterprise-config:

    docker run --rm -v ges_enterprise-config:/data -v "$PWD":/backup postgres:18-alpine \ tar xzf /backup/enterprise-config.tar.gz -C /data
  4. Start only the database and load the copy into it. The enterprise-postgres-data volume must be empty — then postgres creates an empty database from the .env variables:

    docker compose up -d postgres docker compose exec -T postgres sh -c 'psql -U "$POSTGRES_USER" -d "$POSTGRES_DB"' < ges-db.sql
  5. Start the other services:

    docker compose --profile ai up -d
  6. Check the service status as described in Service health checks.

Install with Helm

In Kubernetes, service data is kept in PersistentVolumeClaims created by the chart. The data is the same as in Docker Compose: GES settings, portal data, AI service data.

  • Back up the PVCs with your cluster tools, for example volume snapshots.

  • If PostgreSQL runs separately, back it up with your PostgreSQL server tools, for example pg_dump.

  • Save values.yaml and the Kubernetes secrets you created as described in Create Secrets.