Орнату
Notarium бір өзіне-өзі жеткілікті образ болып жеткізіледі: жалғыз Node процесі REST API-ді, агенттерге арналған MCP эндпоинтін және жиналған веб-интерфейсті бір портта (әдепкіде 3000) береді. Сыртқы қызметтердің — дерекқордың, брокердің, бөлек іздеу қозғалтқышының — қажеті жоқ: білім қозғалтқышы дәл сол процестің ішінде жұмыс істейді. Бүкіл күй бір ғана /data томында тұрады: қызметтік дерекқор, туынды индекстер, Markdown файлдарыңыз (шындық көзі) және экспорт артефактілері.
Тек Docker (немесе Docker Desktop) және бос порт. Node-ты, дерекқорды не векторлық индексті бөлек орнатудың қажеті жоқ — бәрі образдың ішінде.
Образды іске қосу
Ең жылдам жол — дайын образдан контейнер көтеру:
docker run -d --name notarium \
-p 3000:3000 \
-v notarium-data:/data \
docouno/notarium:latest
Бір ғана /data томы бүкіл күйді ұстайды: қызметтік дерекқорды, индекстерді, жазбаларыңызды және экспорт артефактілерін. Бұдан бөлек баптайтын ештеңе жоқ — 3000 порты да, /data деректер жолы да образға алдын ала сіңірілген. Контейнерді қайта жасағанда том орнында қалады, ал :3000-нің сол жағындағы портты кез келген бос портқа ауыстыруға болады.
docker run соңына пәрмен жазудың қажеті жоқ: образдың кіру нүктесі — кіріктірілген notarium CLI, ол әдепкіде start пәрменін орындайды. Операторлық пәрмендер — backup, restore, admin, healthcheck, version — сол CLI арқылы жүреді. Қараңыз: Образ CLI.
Docker Compose арқылы
Тұрақты жұмыс істейтін орнатылым үшін compose файлы ыңғайлырақ: оны түзету де, нұсқа бақылауында ұстау да оңайырақ, ал restart хост қайта жүктелген соң контейнерді өзі көтеріп береді.
services:
notarium:
image: docouno/notarium:latest
restart: unless-stopped
ports:
- "3000:3000"
volumes:
- notarium-data:/data
volumes:
notarium-data:
Осыны жұмыс қалтаңызға compose.yaml файлы етіп сақтаңыз да, docker compose up -d арқылы көтеріңіз. notarium-data атаулы томы контейнерден бөлек өмір сүреді: docker compose down оған тимейді, томды тек айқын docker volume rm пәрменімен ғана жоюға болады.
Орта айнымалылары сервистің environment: блогында беріледі. Оларды бөлек файлда ұстағыңыз келсе, сол жерге env_file: .env жолын қосыңыз — compose файлының қасында жатқан .env өздігінен контейнерге түспейді: Docker Compose оны тек compose файлының өз мәтініне ғана қояды. Толық тізім — Орта айнымалылары.
Алғашқы іске қосу
http://localhost:3000 мекенжайын ашыңыз — сізді алғашқы іске қосудың setup-экраны қарсы алады. Әдепкіде дана password режимінде жұмыс істейді, ал бірінші келуші иені тіркейді — әкімші құқығы бар әрі өзі құратын кеңістіктердің иесі болатын жалғыз аккаунт. Алдын ала орнатылған пароль жоқ; ие тіркелген соң setup біржола жабылады. Режимдер туралы толығырақ — Аутентификация бетінде.
Деректер томдары
| Том | Нені сақтайды | Сипаты |
|---|---|---|
/data | Markdown файлдарыңызды (/data/spaces, әр кеңістікке бір қалта), қызметтік дерекқорды (/data/meta.db — идентификаторлар, нұсқалар тарихы, пайдаланушылар, рұқсаттар), қозғалтқыштың туынды индекстерін (/data/engine) және экспорт артефактілерін. | Файлдар — шындық көзі (file-first қағидасы); қызметтік дерекқорды файлдардан шығарып алу мүмкін емес; индекстер — туынды нәрсе, қайта жинау арқылы қалпына келеді. |
Томның өзін ұқыппен сақтаңыз: ол жоғалса, деректер де бірге кетеді. /data/engine ішіндегі индекстер жоғалса файлдардан қайта жиналады, ал қызметтік дерекқорды (/data/meta.db — тарих, пайдаланушылар, рұқсаттар) мен жазбалардың өзін (/data/spaces) ешқайдан қалпына келтіру мүмкін емес — оларды сақтық көшірмелеу міндетті. Қызметті тоқтатпай тексерілген сақтық көшірмені қалай алу керегі — Сақтық көшірме және қалпына келтіру бетінде.
Бастапқы кодтан жинау
Егер Notarium репозиторийімен жұмыс істесеңіз, Docker үшін жалғыз кіру нүктесі — make:
cp .env.example .env # әдепкі мәндер жұмысқа жарамды — ештеңе толтырудың қажеті жоқ
make up # прод-образ жергілікті түрде → http://localhost:3000
make dev # hot-reload (HMR) бар dev-стек
Пайдалы пәрмендер: make logs (логтар), make ps (күй), make down (тоқтату және жою), make sh (контейнердегі shell).
Тізілімсіз орнату (air-gapped)
Оқшауланған контурға орналастыру үшін образды тізілімге қосылмай-ақ, файл түрінде тасымалдауға болады:
make image # образды жинау
make save # notarium-<version>.tar.gz файлына экспорттау
# мұрағатты мақсатты хостқа тасымалдаңыз, содан кейін:
docker load < notarium-<version>.tar.gz # образды жүктеу
Әрі қарай оны өзіңіздің compose/.env файлдарыңызбен іске қосыңыз — тізілім координатасы образға сіңірілмейді.
Келесі қадам — дананы өзіңізге ыңғайлап баптау: Конфигурация бетін қараңыз.