Install with Docker Compose

Before installing, prepare everything listed in Requirements and Preparation: Docker and Docker Compose 2.0+, credentials for registry.gram.ax, a license key, GitLab and domains.

Download

Download the files with: curl -o docker-compose.yaml https://gram.ax/enterprise-docker-compose.yaml -o .env https://gram.ax/enterprise.env.

Contents

docker-compose.yaml starts these services:

  • caddy — reverse proxy; accepts requests on ports 80 and 443 and issues TLS certificates.

  • enterprise — the GES server and the browser editing app.

  • docportal — the documentation portal. Portal data is stored in the ./docportal folder next to docker-compose.yaml.

  • postgres — the GES database.

  • diagram-renderer — diagram rendering.

  • auth — OAuth endpoints for import from Confluence and Notion. In newer GES versions these endpoints are served by the enterprise service, and a separate auth container is not needed.

  • ges-ai and qdrant — AI features. They start only with the ai profile.

Configuration

Before starting, set the following variables either via environment variables or in the .env file.

Variables missing from docker-compose.yaml

Containers receive only the variables listed in the service's environment section. If a variable you need is not there, for example HEALTHCHECK_TOKEN or WORKSPACE_TOOLS_PROJECT_PATH, add it to environment yourself.

Domains

The Caddy configuration is written in docker-compose.yaml, in the caddy service command. Replace the sample addresses there with your domains:

  • docportal.gramax.local — the documentation portal domain.

  • app.gramax.local — the GES domain. It is also set in GES_URL. On this domain Caddy routes /ai/* to the ges-ai service, /auth* to auth, /diagram-renderer* to diagram-renderer, and all other requests to enterprise.

Add both domains to ALLOWED_GRAMAX_URLS.

Main parameters

  • CLIENT_NAME — client login for Gramax Enterprise Server. Used for authentication in Docker Registry and when substituting values into configuration variables. Issued at purchase. Required. Example: gramax

  • GES_URL — URL where GES will be available. Required. Example: https://enterprise.gramax.local

  • AUTH_SERVICE_URL — URL of the OAuth endpoints users go through to connect external services, for example Confluence and Notion for import. The endpoints answer under /auth. In the .env template: ${GES_URL}/auth. Example: https://ges.gram.ax/auth

  • DIAGRAM_RENDERER_SERVICE_URL — URL where the Diagram-renderer service will be available. Example: https://ges.gram.ax/diagram-renderer

  • DOCPORTAL_SERVICE_URL — internal documentation portal URL. Enterprise uses it to collect the portal status through its health check. Docker Compose example: http://docportal

  • ALLOWED_GRAMAX_URLS — URLs of Gramax instances (documentation portal, browser version, and GES), comma-separated. No trailing comma. Required. Example: https://some-instance.gram.ax,https://another-instance.gram.ax

  • LICENSE_KEY — license key for Gramax Enterprise Server. Issued at purchase. Required. Example: 765d562b9092eec3…

  • GIT_SERVER_TOKEN — access token for the Git server for reading/cloning repositories. Required. Example: glpat-...

  • GES_ADMIN_EMAILS — workspace owner emails, comma-separated. Written to config only on first startup. Required. Example: admin1@gramax.local,admin2@gramax.local

  • GIT_SERVER_URL — GitLab server address for external storage. Required. Example: https://gitlab.example.com

  • ENTERPRISE_STORAGE_TYPE — configuration storage type: gitlab or local. Default: local. Example: gitlab

  • ENTERPRISE_CONFIG_PATH — for ENTERPRISE_STORAGE_TYPE=local: path to the GES settings folder on the virtual machine. Required. Default: /app/config

  • GIT_PROJECT_PATH — for ENTERPRISE_STORAGE_TYPE=gitlab: path to the settings repository in GitLab, as group/repository-name. Must be created before initialization. Required. Example: dr/gramax-yaml-manager

  • GIT_PROJECT_BRANCH — branch of the GIT_PROJECT_PATH repository, if it differs from master. Default: master. Example: main

  • WORKSPACE_TOOLS_PROJECT_PATH — path to the GitLab project with the shared materials, as group/repository-name. Without it the shared materials are off. Example: gramax/workspace-tools

  • ENTERPRISE_CONFIG_PROBE_INTERVAL_MS — with ENTERPRISE_STORAGE_TYPE=gitlab: how often GES checks whether GitLab is available and whether the settings in the repository have changed, in milliseconds. Default: 15000. Example: 15000

  • ENTERPRISE_SERVICE_ENCRYPTION_KEY — key for secure data transfer between services. Required. Example: 5caf59ed...cddb8489

  • HEALTHCHECK_TOKEN — shared secret for access to detailed Enterprise and documentation portal health checks. Set the same value in both containers. Example: a1b2c3d4e5f6...

  • COOKIE_SECRET — key for encrypting user secrets in cookies. At least 32 characters, no whitespace; you can generate one with openssl rand -hex 32. After the secret changes, users have to sign in again. The service does not start without a valid value. Required. Example: 397b6f3bf51a73b9...

  • WEB_EDITOR_URL — the web editor URL used by the desktop application to generate article links via «Share article».

Start

Container registry login

Before the first launch, authenticate in our image registry.

  1. On the deployment host, run:

    docker login registry.gram.ax
  2. Enter credentials:

    • Login: value of CLIENT_NAME

    • Password: token sent together with the license key

If credentials are correct, Docker returns a success message, for example: Login Succeeded

After setting environment variables, start GES with docker compose up -d.

Configuration files are created automatically on first start. Required parameters are taken from the .env file.

After starting, connect SSO and complete the First Run.

Update

How to update GES — see Upgrade.