Install with Helm

Before installing the chart, make sure the cluster meets the requirements in Requirements and Preparation.

Add repository

To install the chart, add our public Helm repository:

helm repo add gramax https://s3.ics-it.ru/public/docreader/helm/ helm repo update

Then verify repository availability with helm search repo gramax.

Example values.yaml

To fill in the variables faster, download a values.yaml template:

curl -LO https://gram.ax/example.values.yaml

Configure Gramax Enterprise Server

Set 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».

Also configure SSO connection, AI features, and logging.

Create secrets

Create secrets for pulling images, for sensitive variables, and for TLS certificates. See Create Secrets.

Helm chart system values

If needed, configure service resources (CPU and memory) and Ingress access settings. See Helm Chart System Values.

Install chart

Once the repository is added and everything is configured, install the chart in your Kubernetes cluster:

helm install gramax gramax/gramax-enterprise-server-in-k8s -n <...> --create-namespace -f values.yaml

Using existing Secret:

helm install gramax gramax/gramax-enterprise-server-in-k8s \ -n <...> \ --create-namespace \ -f values.yaml \ --set secrets.create=false \ --set secrets.name=gramax-app-secrets

After starting — First Run.