First Run

On the first run after installation, GES creates its settings files and assigns the space owners by itself. Below is what happens at start and how to check that everything works.

What happens at start

  1. Database. In Docker Compose, the enterprise service waits until the postgres service is ready. Then GES connects to the database, creates the gramax schema and runs migrations. See GES Database.

  2. Settings files. GES checks the settings storage and creates the files that are missing in it: workspace.yaml, editors.yaml, workspace-access.yaml, groups.yaml, check.yaml, mail-server.yaml and guests.yaml.

    • With ENTERPRISE_STORAGE_TYPE=gitlab, the files appear in the GIT_PROJECT_PATH repository in one commit init: Create default configuration files.

    • With ENTERPRISE_STORAGE_TYPE=local, the files appear in the ENTERPRISE_CONFIG_PATH folder. In docker-compose.yaml, this is the enterprise-config volume.

    GES takes the values from environment variables: CLIENT_NAME, GES_URL, GIT_SERVER_URL, WEB_EDITOR_URL, AUTH_SERVICE_URL and DIAGRAM_RENDERER_SERVICE_URL go into workspace.yaml.

  3. Space owners. Emails from GES_ADMIN_EMAILS are written to workspace-access.yaml as space owners and to editors.yaml as editors.

Settings are created once

GES does not overwrite settings files that already exist. So changing GES_ADMIN_EMAILS or the other variables above after the first run does not change the settings. After that, owners and users are managed in the admin panel, see Roles and Access.

If GitLab is unavailable at start, GES does not stop: it keeps trying to connect until GitLab responds.

If required variables are missing, the enterprise service logs show Missing default config variables or Missing gitlab config variables with the list of missing variables. In Docker Compose, view the logs with docker compose logs enterprise.

Check the services

  1. Check that the service responds:

    curl https://{GES_URL}/health/liveness curl https://{GES_URL}/health/readiness

    Both requests must return code 200. Right after start, some checks may still be running — in that case repeat the request in a minute.

  2. If HEALTHCHECK_TOKEN is set, request the detailed module status:

    curl -H "Authorization: Bearer {HEALTHCHECK_TOKEN}" https://{GES_URL}/health

    How to read the response and set up the token — see Service health checks.

Sign in to GES

  1. Open the GES_URL address in a browser. The browser app opens.

  2. Sign in through SSO with an email from GES_ADMIN_EMAILS. Sign-in works only when SSO is configured: without the AUTH_METHOD variable, sign-in is disabled. See Connect SSO.

  3. Open the documentation portal domain and check that the portal opens.

To connect the desktop app to GES, enter the GES_URL address when signing in. Step-by-step instructions for editors are in Sign In to the App, the Enterprise tab.

After signing in, the space owner sets up the space, catalogs and users in the admin panel. See Settings.

Next steps

Connect the features you need: SSO, database, AI, logging. Instructions are in Setup After Installation.