gramax/docportal repository overview

⁠Gramax docportal docker image

⁠Quick reference

⁠Maintained by:

Gramax team⁠

⁠Where to get help:

Gramax telegram chat⁠⁠

⁠Quickstart

More info can be found at Deploy on Your Own Server | Gramax Docs⁠

Gramax docportal is a portal for readers that can be deployed on your own server.

Deployment in Docker is supported from version 20.10.

⁠Deployment

Creating the file

To work with Gramax docportal 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/docportal-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:

services:
  gramax:
    image: gramax/docportal:latest
    container_name: gramax
    restart: unless-stopped
    ports:
      - ${PORT:-80}:80
    environment:
      - ADMIN_LOGIN=${ADMIN_LOGIN:-admin}
      - ADMIN_PASSWORD=${ADMIN_PASSWORD:-password}
      - AUTO_PULL_TOKEN=${AUTO_PULL_TOKEN:-}
      - AUTO_PULL_INTERVAL=${AUTO_PULL_INTERVAL:-}
    volumes:
      - ${ROOT_PATH:-./gramax}:/app/data

Environment Variables

Regardless of which deployment method you choose, the following environment variables must be specified in the Docker image:

• ROOT_PATH -- The path to the folder where directories will be stored. This is a required parameter; if not specified, the application will not start.

• ADMIN_LOGIN -- The administrator's login. If not specified, the default value is admin.

• ADMIN_PASSWORD -- The administrator's password. If not specified, the default value is password.

• PORT -- The application's port. If not specified, the default value is 80.

Starting

After creating or loading the docker-compose.yaml file, specify the necessary environment variables and run the docker compose up command to start.

Stop

To stop, use the command: docker compose down.

Update

To update, stop the container and use the command

docker compose pull && docker compose up