docs(readme): rebrand to Gitmost fork with EE-free positioning, MCP comparison, grouped roadmap and RU translation
Rewrite README around the community fork story: - state Gitmost is an AGPL-only fork of Docmost with NO Enterprise-Edition code (ee dirs removed) and replacements written from scratch - add a "What's different from Docmost" table (EE removal, comment resolution, embedded MCP, rebranding, compact tree, GHCR CI) - reframe the MCP section: it is our own docmost-mcp built in, better than Docmost's coarse EE MCP (agent-native tools), and the same server as the standalone one — just bundled (Docmost + docmost-mcp in one package) - group the roadmap into Done / In progress / Planned; done: MCP, macOS app; in progress: AI chat, git sync; planned: templates, viewer comments, password-protected pages, Windows/Linux app, mobile app, offline/PWA, and a batch of editor & UX improvements - update the License section to reflect the absence of EE directories - add README.ru.md (full Russian translation) and an English/Russian language switcher to both files
This commit is contained in:
142
README.ru.md
Normal file
142
README.ru.md
Normal file
@@ -0,0 +1,142 @@
|
||||
<div align="center">
|
||||
<h1><b>Gitmost</b></h1>
|
||||
<p>
|
||||
Совместная вики и система документации с открытым исходным кодом.
|
||||
<br />
|
||||
Полностью открытый community-форк <a href="https://github.com/docmost/docmost">Docmost</a>.
|
||||
</p>
|
||||
</div>
|
||||
<br />
|
||||
|
||||
[English](README.md) · **Русский**
|
||||
|
||||
## Об этом форке
|
||||
|
||||
**Gitmost** — это community-форк [Docmost](https://github.com/docmost/docmost),
|
||||
открытой системы для совместной работы над вики и документацией.
|
||||
|
||||
Цель форка — **сборка на 100% открытая, только под AGPL, без кода Enterprise-редакции (EE)**:
|
||||
|
||||
- **Никакого EE-кода.** Весь проприетарный код Enterprise-редакции удалён — приватный
|
||||
сабмодуль `apps/server/src/ee`, каталог `apps/client/src/ee` (201 файл) и пакет
|
||||
`packages/ee`. Никаких лицензионных ограничений: все функции доступны всем.
|
||||
- **Замены написаны с нуля.** Функции, которые раньше были скрыты за enterprise-лицензией
|
||||
(например, резолв комментариев, сервер `/mcp`), переписаны с нуля поверх community-кодовой
|
||||
базы. EE-код не переиспользуется, нет проверок entitlement и feature-флагов.
|
||||
- **Никакого навязывания.** В интерфейсе нигде нет плашек «купите лицензию» / «перейдите на
|
||||
Enterprise», напоминаний о триале и заглушек на месте заблокированных функций.
|
||||
- Аутентификация — обычная пара email + пароль (без SSO/LDAP/облака/биллинга).
|
||||
|
||||
## Чем отличается от Docmost
|
||||
|
||||
| Изменение | Подробности |
|
||||
| --- | --- |
|
||||
| **Удалён EE-код** | Вырезан весь код Enterprise-редакции на клиенте и сервере; это чистая community/AGPL-сборка без лицензионных проверок. |
|
||||
| **Резолв комментариев** | Переписан с нуля как community-функция (резолв / переоткрытие с вкладками «Открытые» / «Решённые»). EE-код не используется, доступно любому, кто может комментировать. |
|
||||
| **Встроенный MCP-сервер** | Community MCP-сервер (`@docmost/mcp`, 38 инструментов) отдаётся по HTTP на `/mcp` — без enterprise-лицензии. Заменяет удалённый лицензируемый EE MCP. |
|
||||
| **Ребрендинг** | Логотип / название приложения изменены с *Docmost* на *Gitmost*. |
|
||||
| **Компактное дерево страниц** | Отступ дерева страниц по умолчанию уменьшен с 16px до 8px на уровень вложенности. |
|
||||
| **CI / образы** | Release-CI публикует контейнерные образы в GHCR (`ghcr.io/vvzvlad/gitmost`) через встроенный `GITHUB_TOKEN` вместо Docker Hub. |
|
||||
|
||||
### Встроенный MCP-сервер
|
||||
|
||||
В Gitmost есть **наш собственный MCP-сервер** — [docmost-mcp](https://github.com/vvzvlad/docmost-mcp),
|
||||
который мы написали сами, — **встроенный прямо в приложение** и доступный на `/mcp`. Он даёт
|
||||
**38 agent-native инструментов**: точечное редактирование по блокам (patch / insert / delete
|
||||
по id), find/replace с сохранением структуры, скриптовые трансформации `(doc) => doc` с
|
||||
предпросмотром диффа, структурное редактирование таблиц, история версий с диффом /
|
||||
восстановлением, комментарии, изображения и ссылки на шаринг — всё применяется через слой
|
||||
real-time-коллаборации Docmost, поэтому запись никогда не затирает параллельную правку
|
||||
человека.
|
||||
|
||||
**Лучше, чем родной MCP у Docmost.** Встроенный MCP у Docmost — enterprise-функция, и его
|
||||
инструменты примитивные: прочитать страницу как Markdown, создать / переместить / удалить
|
||||
страницу, заменить страницу целиком. Наш сделан под то, как агент реально редактирует:
|
||||
адресовать один блок и пропатчить его или *запрограммировать* изменение, а не гонять
|
||||
документ на ~100 КБ через модель ради каждой мелкой правки. И enterprise-лицензия не нужна.
|
||||
|
||||
| | **`/mcp` в Gitmost (наш docmost-mcp)** | Родной MCP у Docmost |
|
||||
| --- | :---: | :---: |
|
||||
| **Enterprise-лицензия** | Не нужна | Нужна |
|
||||
| **Инструменты** | 38, agent-native | Примитивные (Markdown, CRUD страниц, замена целиком) |
|
||||
| **Правки по блокам / find-replace / скриптовые трансформации** | ✅ | — |
|
||||
| **Структурное редактирование таблиц, дифф / восстановление версий** | ✅ | — |
|
||||
| **Комментарии, изображения, ссылки на шаринг** | ✅ | — |
|
||||
| **Безопасная запись через real-time-коллаборацию (без затирания)** | ✅ | — |
|
||||
|
||||
**Это тот же сервер, что и отдельный docmost-mcp, — просто встроенный.** Это ровно тот самый
|
||||
[docmost-mcp](https://github.com/vvzvlad/docmost-mcp), который можно запускать и отдельно;
|
||||
от встраивания он не становится «мощнее» — просто не нужно ставить и держать отдельный
|
||||
процесс. Админ включает его одним переключателем в **Настройки воркспейса → AI & MCP**, а
|
||||
любой MCP-клиент указывает на `${APP_URL}/mcp`.
|
||||
|
||||
## Дорожная карта
|
||||
|
||||
### Готово
|
||||
|
||||
- ✅ **MCP-сервер** — встроенный community MCP-сервер на `/mcp`.
|
||||
- ✅ **Приложение для macOS** — нативное приложение для macOS ([docmost-app](https://github.com/vvzvlad/docmost-app)), встраивающее UI с вкладками для нескольких серверов.
|
||||
|
||||
### В процессе
|
||||
|
||||
- 🚧 **AI-чат** — встроенный чат с AI-агентом по содержимому вики.
|
||||
- 🚧 **Синхронизация с Git** — двусторонняя синхронизация страниц с Git-репозиторием.
|
||||
|
||||
### В планах
|
||||
|
||||
- 🔭 **Шаблоны** — переиспользуемые шаблоны страниц.
|
||||
- 🔭 **Комментарии зрителей** — возможность комментировать для пользователей с доступом только на чтение.
|
||||
- 🔭 **Защищённые паролем страницы** — защита отдельных страниц / шар паролем.
|
||||
- 🔭 **Приложение для Windows / Linux** — нативное десктоп-приложение для Windows и Linux.
|
||||
- 🔭 **Мобильное приложение** — нативное мобильное приложение.
|
||||
- 🔭 **Офлайн-режим** — офлайн-синхронизация и поддержка PWA.
|
||||
- 🔭 **Улучшения редактора и UX** — блоки внутри таблиц (списки, чек-листы), колоночная вёрстка, дополнительные уровни заголовков, highlight-блоки, кастомные эмодзи в callout-ах, плавающие изображения, anchor-ссылки на упоминания страниц, тоглы (ширина шары, aside/сайдбар, spellcheck, лигатуры), санитизация экспорта дерева спейса и mentions в хлебных крошках.
|
||||
|
||||
## С чего начать
|
||||
|
||||
Gitmost повторяет процесс установки upstream-Docmost. Инструкции по self-hosting и разработке
|
||||
смотрите в [документации](https://docmost.com/docs) Docmost; где это применимо, заменяйте образ
|
||||
`docmost/docmost` на `ghcr.io/vvzvlad/gitmost`.
|
||||
|
||||
## Возможности
|
||||
|
||||
- Совместная работа в реальном времени
|
||||
- Диаграммы (Draw.io, Excalidraw и Mermaid)
|
||||
- Пространства (Spaces)
|
||||
- Управление правами доступа
|
||||
- Группы
|
||||
- Комментарии (с резолвом / переоткрытием)
|
||||
- История страниц
|
||||
- Поиск
|
||||
- Вложения файлов
|
||||
- Встраивания (Airtable, Loom, Miro и другие)
|
||||
- Переводы (10+ языков)
|
||||
- Встроенный MCP-сервер (`/mcp`)
|
||||
|
||||
### Скриншоты
|
||||
|
||||
<p align="center">
|
||||
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%">
|
||||
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%">
|
||||
</p>
|
||||
|
||||
### Лицензия
|
||||
|
||||
Gitmost распространяется под открытой лицензией AGPL 3.0.
|
||||
|
||||
В отличие от upstream-Docmost, этот форк **не содержит кода Enterprise-редакции** — каталоги
|
||||
`apps/server/src/ee`, `apps/client/src/ee` и `packages/ee` удалены, поэтому файлов под
|
||||
enterprise-лицензией здесь нет.
|
||||
|
||||
### Благодарности
|
||||
|
||||
Gitmost основан на [Docmost](https://github.com/docmost/docmost) от команды Docmost. Огромное
|
||||
спасибо им за оригинальный открытый проект.
|
||||
|
||||
<img width="100" alt="Crowdin" src="https://github.com/user-attachments/assets/a6c3d352-e41b-448d-b6cd-3fbca3109f07" />
|
||||
|
||||
[Crowdin](https://crowdin.com/) — за доступ к их платформе локализации.
|
||||
|
||||
<img width="48" alt="Algolia-mark-square-white" src="https://github.com/user-attachments/assets/6ccad04a-9589-4965-b6a1-d5cb1f4f9e94" />
|
||||
|
||||
[Algolia](https://www.algolia.com/) — за полнотекстовый поиск по документации.
|
||||
Reference in New Issue
Block a user