Описание конфигурации

Установка довольно проста:

1. Клонировать репозиторий
2. Заполните заголовок и описание, настройте меню и т. д.
3. Начать

Использование метода

Шаг 1. Клонировать

Во-первых, вам необходимо клонировать репозиторий codex.docs:

git clone https://github.com/codex-team/codex.docs.git

Шаг 2. Настройте

Cоздайте docs-config.local.yaml вашу конфигурацию:

touch docs-config.local.yaml

Вы можете оставить этот файл пустым, чтобы использовать конфигурацию по умолчанию. Вы также можете переопределить некоторые свойства конфигурации. Документацию по свойствам конфигурации можно найти на этой странице.

Шаг 3. Установите зависимости и запустите

У вас должна быть версия node.js выше 16 и программа Yarn на компьютере. Затем выполните следующие команды

version: "3.2"
services:
  docs:
    image: ghcr.io/codex-team/codex.docs:v2
    ports:
      - 127.0.0.1:3000:3000
    environment:
      - APP_CONFIG_auth_password=codex
    volumes:
      - ./uploads:/usr/src/app/uploads
      - ./db:/usr/src/app/db
      - ./docs-config.yaml:/usr/src/app/docs-config.yaml

Вы можете оставить этот файл пустым, чтобы использовать конфигурацию по умолчанию. Вы также можете переопределить некоторые свойства конфигурации. Документацию по свойствам конфигурации можно найти на этой странице.