Орнату және іске қосу
Notarium бір өзіне-өзі жеткілікті образ ретінде жеткізіледі: бір процесс веб-интерфейсті, REST API-ді және агенттерге арналған MCP-эндпоинтті береді, ал білім қозғалтқышы дәл сол процестің ішінде жұмыс істейді. Сыртқы қызметтердің — дерекқордың, брокердің, бөлек іздеу қозғалтқышының — қажеті жоқ. Бастау үшін керегінің бәрі — Docker пен бос порт.
Бұл бет — жылдам жол: дананы көтеру, оны браузерде ашу және иесін тіркеу. Толық өзіндік хостинг (Postgres, кері прокси, өнімдік конфигурация) Өзіндік хостинг бөліміне шығарылған.
Не қажет болады
- 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-нің сол жағындағы портты кез келген бос портқа ауыстыруға болады.
Егер образ әлі тізілімнен тартылмаған болса — оны Notarium негізгі репозиторийіндегі бастапқы кодтан make up командасымен құрастырыңыз (төменге қараңыз): әрекеті бірдей.
Балама жол — Docker-ге қатысты бәрінің бірыңғай кіру нүктесі make арқылы бастапқы кодтан құрастыру:
cp .env.example .env # әдепкі мәндер жарамды — ештеңе толтыру міндетті емес
make up # прод-образды құрастырып, көтеру → http://localhost:3000
Қалған командалар эксплуатацияда пайдалы: make logs — логтар, make ps — статус, make down — тоқтатып, өшіру, make sh — контейнердегі shell.
Томдар: деректер қайда жатады
Бүкіл күй бір ғана томда тұрады — контейнерді қайта жасағанда сақтап қалу керегі осы:
| Том | Монтаждау нүктесі | Нені сақтайды |
|---|---|---|
notarium-data | /data | Бәрін: жазбаларыңызды (/data/spaces), қызметтік дерекқорды (/data/meta.db), туынды іздеу индекстерін (/data/engine) және экспорт артефактілерін (/data/jobs) |
Түйінді қағида — file-first: шындық дегеніміз — /data/spaces ішіндегі .md-файлдар. /data/engine ішіндегі іздеу индекстері мен граф — туынды: олар файлдардан қайта құрастырылады, сондықтан жоғалса, қайта индекстеу оларды қайтарады. Ал қызметтік /data/meta.db дерекқоры — нұсқалар тарихы, пайдаланушылар мен рұқсаттар — тек томда ғана тұрады, сондықтан /data-ны жазбаларыңызбен бірдей ұқыппен сақтайды. Сақтық көшірме үшін жазбаларыңыз бен meta.db міндетті; туынды индекстерді көшірмелеу міндетті емес.
3000 портын -p <өз портыңыз>:3000 тіркесінің сол жағынан (немесе .env ішіндегі PORT айнымалысымен) өзгертесіз. Образ контейнердің барлық интерфейстерінде тыңдайды — сыртқа дәл сіз бағыттаған нәрсені береді.
Алғашқы іске қосу: setup-экран
Алғашқы кіргеніңізде Notarium сізді setup-экранмен қарсы алады. Алдын ала орнатылған пароль жоқ: бірінші келуші дананың иесін тіркейді — бұл аккаунт әкімшіге әрі құрылатын кеңістіктердің иесіне айналады. Одан кейін setup біржола жабылады, ал сіз редакторда, өзіңіздің жеке кеңістігіңіздің ішінде боласыз.
Әдепкі аутентификация режимі — AUTH_MODE=password — осылай жұмыс істейді. Ол көпшілікке қолжетімді данаға есептелген: логин, сессиялар, агенттерге арналған жеке токендер. Екінші режим — none (толық қолжетімділігі бар жалғыз субъект, логин экраны жоқ) — тек сенімді ортаға ғана лайық: жұмыс үстелі, жергілікті әзірлеу немесе жабық интранет. Толығырақ — Аутентификация бөлімінде.
Негізгі конфигурация
Әдепкі баптаулар zero-config: бастау үшін образ сол күйінде жеткілікті. Нәзік баптау — орта айнымалылары арқылы (Docker-де оларды .env жеткізеді, образға ештеңе сіңірілмейді):
| Айнымалы | Мәні | Әдепкі |
|---|---|---|
PORT | Сервер тыңдайтын порт | 3000 |
AUTH_MODE | password (логин + setup) немесе none (сенімді орта) | password |
VECTOR_SEARCH | Лексикалық іздеуге қосымша семантикалық (векторлық) іздеуді қосу | образда off |
Толық мәтіндік іздеу әрдайым, ешбір баптаусыз жұмыс істейді. Семантикалық (векторлық) іздеу қалау бойынша, VECTOR_SEARCH=on жалаушасымен қосылады: ол жергілікті эмбеддинг моделін тартады (шамамен жүздеген мегабайт RAM), сондықтан жарияланған образда өшірулі тұрады да, саналы түрде қосылады. Онсыз да іздеу толық мәтін бойынша жұмысын жалғастырады — қатесіз, бұл штаттық режим. Айнымалылардың толық тізімі мен іздеуді баптау — Конфигурация және Іздеуді баптау бөлімдерінде.
Әрі қарай
Дана көтерілді, ие тіркелді — енді білім қорын толтырып, оны агентке ашатын уақыт:
- Алғашқы жазба — файлдар ағашы, веб-редактор және
.md-ға сақтау. - Агентті қосу — токен,
POST /mcpэндпоинті және алғашқы шақыру.
Модельді тұтастай түсінгіңіз келсе — Концепциялар бөлімін қараңыз: кеңістіктер, жазба түрлері, граф және рұқсат моделі.