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