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
Database. In Docker Compose, the
enterpriseservice waits until thepostgresservice is ready. Then GES connects to the database, creates thegramaxschema and runs migrations. See GES Database.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.yamlandguests.yaml.With
ENTERPRISE_STORAGE_TYPE=gitlab, the files appear in theGIT_PROJECT_PATHrepository in one commitinit: Create default configuration files.With
ENTERPRISE_STORAGE_TYPE=local, the files appear in theENTERPRISE_CONFIG_PATHfolder. Indocker-compose.yaml, this is theenterprise-configvolume.
GES takes the values from environment variables:
CLIENT_NAME,GES_URL,GIT_SERVER_URL,WEB_EDITOR_URL,AUTH_SERVICE_URLandDIAGRAM_RENDERER_SERVICE_URLgo intoworkspace.yaml.Space owners. Emails from
GES_ADMIN_EMAILSare written toworkspace-access.yamlas space owners and toeditors.yamlas editors.
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
Check that the service responds:
curl https://{GES_URL}/health/liveness curl https://{GES_URL}/health/readinessBoth requests must return code
200. Right after start, some checks may still be running — in that case repeat the request in a minute.If
HEALTHCHECK_TOKENis set, request the detailed module status:curl -H "Authorization: Bearer {HEALTHCHECK_TOKEN}" https://{GES_URL}/healthHow to read the response and set up the token — see Service health checks.
Sign in to GES
Open the
GES_URLaddress in a browser. The browser app opens.Sign in through SSO with an email from
GES_ADMIN_EMAILS. Sign-in works only when SSO is configured: without theAUTH_METHODvariable, sign-in is disabled. See Connect SSO.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.