Установка и запуск

Notarium поставляется как один самодостаточный образ: один процесс отдаёт веб-интерфейс, REST-API и MCP-эндпоинт для агентов, а движок знаний работает прямо внутри него. Внешних сервисов — базы, брокера, отдельного поискового движка — не нужно. Всё, что требуется для старта, — Docker и свободный порт.

Эта страница — быстрый путь: поднять инстанс, открыть его в браузере и завести владельца. Детальный self-host (Postgres, reverse proxy, продакшн-конфигурация) вынесен в раздел Self-host.

Что понадобится

• Docker (или Docker Desktop) — больше ничего ставить не нужно: Node, база и поисковый индекс уже внутри образа.
• Свободный порт — по умолчанию 3000.
• Немного места на диске под ваши заметки и производный индекс.

Запуск одним контейнером

Самый короткий путь — запустить готовый образ docouno/notarium:

docker run -d --name notarium \
  -p 3000:3000 \
  -v notarium-data:/data \
  docouno/notarium:latest

Через пару секунд откройте http://localhost:3000.

Один том /data держит всё состояние — служебную БД, индексы, ваши заметки, артефакты экспорта. Больше задавать нечего: порт 3000 и путь данных /data уже заданы в образе. Порт слева от 3000 можно сменить на любой свободный.

Альтернатива — сборка из исходников через make, единую точку входа для всего, что в Docker:

cp .env.example .env   # дефолты рабочие — заполнять ничего не обязательно
make up                # собрать прод-образ и поднять → http://localhost:3000

Прочие команды пригодятся при эксплуатации: make logs — логи, make ps — статус, make down — остановить и удалить, make sh — shell в контейнере.

Тома: где лежат данные

Всё состояние живёт в одном томе — его и нужно беречь при пересоздании контейнера:

Ключевой принцип — file-first: истина — это .md-файлы в /data/spaces. Индексы поиска и граф в /data/engine — производное: они пересобираются из файлов, и их потеря восстановима реиндексом. А служебная БД /data/meta.db — история версий, пользователи и доступы — живёт только в томе, поэтому /data берегут наравне с заметками. Для бэкапа обязательны ваши заметки и meta.db; производные индексы бэкапить не обязательно.

Первый запуск: setup-экран

При первом визите Notarium встретит вас setup-экраном. Преднастроенного пароля нет: первый посетитель заводит владельца инстанса — этот аккаунт становится администратором и владельцем создаваемых пространств. После этого setup закрывается навсегда, а вы оказываетесь в редакторе, уже внутри своего личного пространства.

Так работает режим аутентификации по умолчанию — AUTH_MODE=password. Он рассчитан на публично доступный инстанс: логин, сессии, персональные токены для агентов. Второй режим — none (единственный принципал с полным доступом, без экрана логина) — подходит только для доверенного окружения: рабочего стола, локальной разработки или закрытого интранета. Подробности — в разделе Аутентификация.

Базовая конфигурация

Дефолты zero-config: для старта достаточно образа как есть. Тонкая настройка — через переменные окружения (в Docker их прокидывает .env, в образ ничего не запекается):

Полнотекстовый поиск работает всегда и без настройки. Семантический (векторный) поиск включается по желанию, флагом VECTOR_SEARCH=on: он подтягивает локальную модель эмбеддингов (порядка сотен мегабайт RAM), поэтому в опубликованном образе выключен и включается осознанно. Без него поиск продолжает работать по полному тексту — без ошибки, это штатный режим. Полный список переменных и настройка поиска — в разделах Конфигурация и Настройка поиска.

Дальше

Инстанс поднят и владелец заведён — время наполнить базу и открыть её агенту:

• Первая заметка — дерево файлов, веб-редактор и сохранение в .md.
• Подключить агента — токен, эндпоинт POST /mcp и первый вызов.

Хочется понять модель целиком — загляните в раздел Концепции: пространства, типы заметок, граф и модель доступа.