NotariumҚұжаттама
Құжаттама нұсқасы: latest
KZ

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

Notarium орта айнымалылары арқылы бапталады — образға ешқандай құпия немесе жол жазылмайды. Әдепкі мәндер zero-config үшін ойластырылған: таза дана бірде-бір баптаусыз көтеріледі. Бұл бет — негізгі айнымалыларға шолу; нақты мәндер мен әдепкілері бар толық тізім Анықтамалықта.

Конфигурация docker run пәрменінің -e жалаушаларымен немесе .env файлымен беріледі (ол .env.example файлынан көшіріледі). Docker-стек .env файлын контейнерге сол күйінде береді.

Негізгі айнымалылар

АйнымалыМақсатыӘдепкі
DATA_DIRДеректердің жалғыз тұтқасы: қалғанының бәрі — қызметтік дерекқор, индекстер, жазбалар, артефактілер — осы түбірден шығарылады. Берілмесе → жұмысқа жарамды әдепкі мән алынады./data (Docker); ~/.local/share/notarium (host)
PORTБэкенд тыңдайтын порт (/api, /mcp және веб-интерфейс).3000
AUTH_MODEАутентификация режимі: password немесе none.password
META_DB_URLҚызметтік дерекқор: sqlite:<path> немесе postgres://…. Міндетті емес — тек сыртқы Postgres үшін беріледі; әдепкіде бұл DATA_DIR астындағы SQLite.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 коннекторы) токенді қолмен енгізбей-ақ өзі авторизациядан өтеді. Мұны бөлек баптаудың қажеті жоқ: клиенттер динамикалық тіркеледі. Кері прокси артында PUBLIC_BASE_URL орнатыңыз (мысалы, https://notes.example.com) — OAuth-метадеректері үшін тұрақты сыртқы мекенжай; онсыз мекенжай проксидің forwarded-тақырыптарынан шығарылады. Сол прокси артында TRUST_PROXY-ді де беріп қойған жөн: кіру әрекеттері мен жаңа коннекторларды қабылдау лимиттері проксидің мекенжайымен емес, клиенттің нақты IP-мекенжайымен есептелсін — Өнімдік орта бетін қараңыз. Агенттерді қосу туралы толығырақ — Агентті қосу.

Толық анықтамалық

Іздеу айнымалылары (EMBED_MODEL, EMBED_DIMENSIONS, EMBED_CPU_MEM_ARENA және т.б.), синхрондау таймингтері мен басқа да нәзік тұтқалар Орта айнымалылары бетіндегі кестелерге жинақталған.

Ары қарай: аутентификацияны және қажет болса, семантикалық іздеуді баптаңыз.