Конфигурация

DocPlatform придерживается подхода convention-over-configuration. Платформа работает с разумными значениями по умолчанию сразу после установки, но каждый аспект настраивается для промышленных развертываний.

Уровни конфигурации

Конфигурация применяется на трех уровнях, от самого широкого к наиболее конкретному:

Уровень Область действия Метод
Переменные окружения Вся платформа Файл .env или переменные окружения оболочки
Конфигурация workspace Отдельный workspace .docplatform/config.yaml
Frontmatter страницы Отдельная страница YAML-блок в каждом файле .md

Уровни с более высокой специфичностью переопределяют более низкие. Например, access: restricted на странице переопределяет значение по умолчанию access: public на уровне workspace.

Руководства

Руководство Что рассматривается
Переменные окружения Все настройки платформы: порт, директория данных, git, SMTP, телеметрия
Настройки workspace Конфигурация workspace: git remote, тема, навигация, настройки публикации
Аутентификация Локальная аутентификация, OIDC-провайдеры (Google, GitHub), настройки JWT, политики паролей
Роли и права доступа 6-уровневая RBAC-иерархия, контроль доступа на уровне страниц, конфигурация Casbin

Краткий справочник

Наиболее распространенные задачи конфигурации:

Задача Где
Изменить порт сервера Переменная окружения PORT
Подключить git-репозиторий Конфигурация workspace git_remote
Включить вход через Google/GitHub Переменные окружения OIDC_*
Настроить email (приглашения, сброс пароля) Переменные окружения SMTP_*
Изменить роль по умолчанию для новых пользователей Конфигурация workspace permissions.default_role
Ограничить документацию участниками команды Переменная окружения PUBLISH_REQUIRE_AUTH=true
Ограничить страницу определенными ролями (веб-редактор) Frontmatter страницы access: restricted
Отключить телеметрию DOCPLATFORM_TELEMETRY=off