Конфігурація
DocPlatform дотримується підходу «домовленості замість конфігурації». Він працює з розумними значеннями за замовчуванням одразу після встановлення, але кожен аспект можна налаштувати для виробничих розгортань.
Рівні конфігурації
Конфігурація застосовується на трьох рівнях, від найширшого до найконкретнішого:
| Рівень | Область | Метод |
|---|---|---|
| Змінні середовища | Вся платформа | Файл .env або змінні середовища оболонки |
| Конфігурація робочого простору | Окремий робочий простір | .docplatform/config.yaml |
| Frontmatter сторінки | Окрема сторінка | Блок YAML у кожному .md файлі |
Більш конкретні рівні перевизначають менш конкретні. Наприклад, access: restricted на рівні сторінки перевизначає значення за замовчуванням access: public робочого простору.
Посібники
| Посібник | Що охоплює |
|---|---|
| Змінні середовища | Усі налаштування рівня платформи: порт, директорія даних, git, SMTP, телеметрія |
| Налаштування робочого простору | Конфігурація окремого робочого простору: git remote, тема, навігація, значення за замовчуванням для публікації |
| Автентифікація | Локальна автентифікація, OIDC провайдери (Google, GitHub), налаштування JWT, політики паролів |
| Ролі та права доступу | 6-рівнева ієрархія RBAC, контроль доступу на рівні сторінок, конфігурація Casbin |
Швидкий довідник
Найпоширеніші завдання конфігурації:
| Завдання | Де |
|---|---|
| Змінити порт сервера | Змінна середовища PORT |
| Підключити git репозиторій | Конфігурація робочого простору git_remote |
| Увімкнути вхід через Google/GitHub | Змінні середовища OIDC_* |
| Налаштувати email (запрошення, скидання пароля) | Змінні середовища SMTP_* |
| Змінити роль за замовчуванням для нових користувачів | Конфігурація робочого простору permissions.default_role |
| Обмежити опубліковану документацію лише для команди | Змінна середовища PUBLISH_REQUIRE_AUTH=true |
| Обмежити сторінку для конкретних ролей (веб-редактор) | Frontmatter сторінки access: restricted |
| Вимкнути телеметрію | DOCPLATFORM_TELEMETRY=off |