Начало работы
В этом разделе описан процесс установки DocPlatform, первого запуска и создания workspace, в котором ваша команда сможет начать работу.
Выберите свой путь
| Путь | Время | Для кого |
|---|---|---|
| Быстрый старт | 5 минут | Быстрая оценка продукта — одна команда, и все работает |
| Установка | 10 минут | Полная настройка — выберите способ (бинарный файл, Docker, из исходного кода), разберитесь, что происходит |
| Ваш первый workspace | 10 минут | Уже запущено — создание workspace, подключение git, приглашение команды |
Перед началом
DocPlatform не имеет внешних зависимостей. Вам не нужно устанавливать базу данных, поисковый движок или среду выполнения Node.js. Единый бинарный файл включает все необходимое.
Опциональные зависимости:
- Git 2.30+ — требуется только для синхронизации с удаленным git-репозиторием
- SSH-ключ — требуется только для приватных git-репозиториев через SSH
- SMTP-сервер — требуется только для email-приглашений и сброса пароля (без SMTP токены сброса выводятся в stdout)
Архитектура в общих чертах
При запуске docplatform serve стартует единый процесс, включающий:
- HTTP-сервер — обслуживает веб-редактор и API на порту 3000
- База данных SQLite — хранит пользователей, workspaces, метаданные страниц и журналы аудита
- Поисковый движок Bleve — индексирует весь контент для мгновенного полнотекстового поиска
- Git-движок — двунаправленная синхронизация контента с удаленными репозиториями
- Статический фронтенд — веб-редактор Next.js, встроенный в бинарный файл
Все данные хранятся в одной директории (по умолчанию: .docplatform/), что упрощает резервное копирование и миграцию — достаточно скопировать эту директорию.