NotariumДокументация
Версия документации: latest
RU

Конфигурация

Notarium настраивается переменными окружения — секретов и путей в образ не запекается. Дефолты рассчитаны на zero-config: чистый инстанс поднимается без единой настройки. Эта страница — обзор ключевых переменных; полный список с точными значениями и дефолтами — в Справочнике.

Конфигурация задаётся флагами -e у docker run либо файлом .env (копируется из .env.example). Docker-стек прокидывает .env в контейнер как есть.

Ключевые переменные

ПеременнаяНазначениеDefault
DATA_DIRЕдинственная ручка данных: корень, из которого выводится всё остальное — служебная БД, индексы, заметки, артефакты. Не задан → берётся рабочий дефолт./data (Docker); ~/.local/share/notarium (host)
PORTПорт, на котором слушает бэкенд (/api, /mcp и веб-интерфейс).3000
AUTH_MODEРежим аутентификации: password или none.password
META_DB_URLСлужебная БД: sqlite:<path> или postgres://…. Опционально — задают только ради внешнего Postgres; по умолчанию это SQLite под DATA_DIR.sqlite:<DATA_DIR>/meta.db
SPACES_ROOTКорень, где каждое пространство — папка; включает создание пространств из интерфейса. Опционально — только если заметки лежат вне DATA_DIR.<DATA_DIR>/spaces
VECTOR_SEARCHon/off — семантический (векторный) поиск.off в опубликованном образе (в коде — on)

Каждая тема раскрыта на своей странице: Аутентификация (AUTH_MODE), База данных (META_DB_URL), Семантический поиск (VECTOR_SEARCH и параметры моделей).

Топология пространств

Есть два способа задать пространства (space):

  • SPACES_ROOT — zero-config: каждое пространство — это папка под указанным корнем. Пространства создаются на первом запуске и кнопкой «New space…» в интерфейсе. Это дефолт Docker-стека.
  • SPACES_CONFIG — явная фиксированная топология (inline-JSON или путь к JSON-файлу). Подходит, когда набор пространств задан оператором и не создаётся из интерфейса.

О модели пространств и проектов — в разделе Концепции.

Аутентификация агентов (OAuth)

Помимо персональных токенов (PAT), Notarium умеет авторизовать MCP-коннекторы по OAuth — так агент (например, коннектор Claude) проходит авторизацию сам, без ручной вставки токена. Отдельной конфигурации это не требует: клиенты регистрируются динамически. За reverse proxy задайте PUBLIC_BASE_URL (например, https://notes.example.com) — стабильный внешний адрес для OAuth-метаданных; без него адрес выводится из forwarded-заголовков прокси. Там же за прокси имеет смысл задать TRUST_PROXY, чтобы лимиты входа и допуска новых коннекторов считались по настоящему IP клиента, а не по адресу прокси — см. Продакшн. Подробнее о подключении агентов — Подключить агента.

Полный справочник

Переменные поиска (EMBED_MODEL, EMBED_DIMENSIONS, EMBED_CPU_MEM_ARENA и др.), тайминги синхронизации и прочие тонкие ручки собраны в таблицах на странице Переменные окружения.

Дальше: настройте аутентификацию и, при необходимости, семантический поиск.