Gramax Enterprise Server

Gramax Enterprise Server (Enterprise, GES) is the server edition of Gramax. A GES server sits between the app and the Git storage: sign-in, access rights and space settings go through it.

GES is deployed as one bundle: it includes the server, the documentation portal for readers and the browser app for editing. You don't need to install the portal or the editor separately.

Features

  • Sign-in via corporate SSO. Editors get all space settings when they sign in to the app. Readers on the documentation portal see only the catalogs available to them.

  • Advanced access management. You can restrict edit and view permissions for catalogs both in the app and on the documentation portal.

  • Company style guide checks. Editors check texts against the rules right in the interface, and the space owner manages the rules.

Architecture

Readers open the documentation portal in a browser, editors work in the app or in the browser version. Caddy receives all requests and routes them to the right service by domain and path. The portal takes catalogs from GitLab and gets sign-in, access rights and space settings from the enterprise server.

The AI service and Qdrant run only when AI features are enabled. Services and domains are described in Install with Docker Compose.

How to get started

  1. Prepare the infrastructure and installation data.

  2. Install GES with Docker Compose on a single server or with Helm in a Kubernetes cluster.

  3. Connect SSO — without it, nobody can sign in to GES.

  4. Complete the first run and check that the services work.

  5. Set up the features you need: database, AI, logging.

  6. Set up maintenance: upgrades, backups and monitoring.

Documentation portal settings common to all installation methods are in Documentation Portal.