gramax/editor repository overview

⁠Gramax editor docker image

⁠Quick reference

⁠Maintained by:

Gramax team⁠

⁠Where to get help:

Gramax telegram chat⁠

⁠Quickstart

Gramax editor is an application for creating, editing, and publishing documentation.

Supported deployment in Docker from version 20.10.

⁠Deployment

Creating the Docker Compose file

To work with Gramax editor via Docker Compose, you can choose one of the following methods:

1. Using the ready-made Docker Compose file: Download it with the command

   curl -LO https://gram.ax/editor-docker-compose.yaml.

2. Creating your own docker-compose.yaml: If you want to customize the application deployment to your needs, you can create your own docker-compose.yaml. Here's an example of a basic configuration for docker-compose.yaml:

version: "3.8"

services:
  editor:
    image: docker.io/gramax/editor:latest
    container_name: editor
    restart: unless-stopped
    ports:
      - ${PORT:-3000}:80
    environment:
      - GIT_PROXY_SERVICE_URL=${GIT_PROXY_SERVICE_URL:-http://localhost:3001}

  git-proxy:
    image: docker.io/gramax/git-proxy:latest
    container_name: git_proxy
    restart: unless-stopped
    ports:
      - ${GIT_PROXY_PORT:-3001}:80
    environment:
      - ALLOWED_GRAMAX_URLS=${ALLOWED_GRAMAX_URLS:-http://localhost:3000}

⁠Service Descriptions

• editor: This is the main service that runs Gramax editor. It is accessible via a web browser on the port specified in the PORT variable (default is 3000). This service also connects to the git-proxy to work with Git repositories.

• git-proxy: This service that runs Gramax Git proxy and is used to bypass CORS restrictions when interacting with remote Git repositories. It receives requests from the editor and forwards them to remote repositories, avoiding browser blockages.

⁠Environment Variables

In the Docker image, you can specify the following environment variables:

• PORT (used by editor)
  The port on which the Gramax editor is accessible. Defaults to 3000 if not specified.

• GIT_PROXY_SERVICE_URL (used by editor)
  The URL the editor uses to connect to the git-proxy service, ensuring proper Git-related functionality.
  Example: GIT_PROXY_SERVICE_URL=http://git-proxy:3001

• ALLOWED_GRAMAX_URLS (used by git-proxy)
  A comma-separated list of allowed domains that can send requests to the git-proxy.
  Example: ALLOWED_GRAMAX_URLS="https://some-instance.gram.ax,https://another-instance.gram.ax"

  Important: Connection from localhost will always be allowed.

Starting

After creating the docker-compose.yaml file, specify the necessary environment variables and run the following command to start:

docker compose up

Stopping

To stop the containers, use the command:

docker compose down

Updating

To update the containers, stop them and use the following command:

docker compose pull && docker compose up