Requirements and Preparation
Before installing Gramax Enterprise Server, prepare access credentials, a Git storage and domains. You will enter most of this data in environment variables when you install with Docker Compose or with Helm.
License and image access
When you buy GES, you receive:
License key — the value of the
LICENSE_KEYvariable.Client login — the value of the
CLIENT_NAMEvariable. It is also part of the image addresses:registry.gram.ax/gx/enterprise/{CLIENT_NAME}/...Image registry token — the password for
registry.gram.ax. The login is theCLIENT_NAMEvalue.
The server or cluster where you install GES must have access to registry.gram.ax to pull images.
GitLab
GES works with catalogs stored in GitLab. Prepare:
GitLab address — the value of the
GIT_SERVER_URLvariable, for examplehttps://gitlab.example.com.GitLab access token — the value of the
GIT_SERVER_TOKENvariable. GES uses it to read and clone repositories. If GES settings are stored in GitLab, the token must also allow writing to the settings repository: GES saves changes to it as commits.
GES settings storage
GES keeps space, user and access settings in YAML files. Choose where they are stored with the ENTERPRISE_STORAGE_TYPE variable:
gitlab— in a separate GitLab repository. Create the repository in advance and set its path inGIT_PROJECT_PATHin the "group/repository-name" format. If the repository's main branch is notmaster, set it inGIT_PROJECT_BRANCH.local— in a folder on the server, set byENTERPRISE_CONFIG_PATH. Default:/app/config. Indocker-compose.yamlthis folder is kept in theenterprise-configvolume.
You don't need to create the settings files: GES creates them on the first run.
Space owners
Decide who will be the space owners and prepare their emails for the GES_ADMIN_EMAILS variable (comma-separated). Use the emails these employees sign in with through SSO.
GES writes the owners to the settings only on the first run. Later, owners are changed in the admin panel.
SSO
You can't sign in to GES without SSO: if the AUTH_METHOD variable is not set, sign-in is disabled. Prepare the connection to your provider: Keycloak, OpenID Connect, Azure, ADFS, LDAP or Kerberos. The data you need is listed in Connect SSO.
Domains and TLS
Prepare two domains and DNS records that point to the server or Ingress:
Documentation portal domain — readers open catalogs on it.
GES domain — the browser app and the GES server run on it. This address goes into
GES_URL, and editors enter it in the desktop app when signing in.
Add both addresses to the ALLOWED_GRAMAX_URLS variable.
HTTPS requires TLS certificates. With Docker Compose, the Caddy reverse proxy issues them. With Helm, prepare certificates or a wildcard certificate.
Encryption keys
Generate two random values, for example with openssl rand -hex 32:
COOKIE_SECRET— at least 32 characters, no spaces.ENTERPRISE_SERVICE_ENCRYPTION_KEY— the key for passing data between services.
Store them in a safe place together with the other variables: if COOKIE_SECRET changes, users have to sign in again.
Install with Docker Compose
Docker and Docker Compose 2.0 or later.
Free ports
80and443on the server: Caddy accepts requests on them.If you enable AI features, prepare access to the embedding and chat models.
Install with Helm
Compute
Minimum requirements:
Limits: