diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000..5241e22 --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,4 @@ +root: ./ +structure: + readme: README.md + summary: SUMMARY.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a71fa4 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# UID.news — Services / Інфраструктура + +Налаштування сервісів для **Gentoo (OpenRC)**: nginx, PostgreSQL, +два інстанси llama.cpp, garage. Init-скрипти та конфіги. + +- Загальна архітектура → [documentation](https://git.uid.net.ua/uid.news/documentation) +- Рішення про Gentoo/OpenRC → [ADR-0006](https://git.uid.net.ua/uid.news/documentation/decisions/0006-gentoo-openrc-deployment.md) + +> ⚠️ **Два інстанси llama.cpp** з різними моделями та призначенням: +> один для векторизації (bge-m3-fp16), другий для перекладу+модерації. +> Не плутати — див. [`llama-cpp/README.md`](llama-cpp/README.md). diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..a5d0582 --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,19 @@ +# Table of contents + +* [Огляд](README.md) + +## Інфраструктура +* [Огляд сервісів](docs/overview.md) +* [Провіженинг хоста](docs/provisioning.md) +* [Мережа](docs/networking.md) + +## Сервіси +* [nginx](nginx/README.md) +* [PostgreSQL](postgresql/README.md) +* [llama.cpp](llama-cpp/README.md) + * [Векторизація (bge-m3-fp16)](llama-cpp/embeddings/docs.md) + * [Переклад і модерація](llama-cpp/translation-moderation/docs.md) +* [garage](garage/README.md) + +## Спільне +* [Конвенції OpenRC](openrc/README.md) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..c316a7f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# Інфраструктура — огляд + +Загальна документація інфраструктури. Конкретні сервіси — у своїх теках. + +- [Огляд сервісів](overview.md) +- [Провіженинг хоста](provisioning.md) +- [Мережа](networking.md) diff --git a/docs/networking.md b/docs/networking.md new file mode 100644 index 0000000..bf1db42 --- /dev/null +++ b/docs/networking.md @@ -0,0 +1,17 @@ +# Мережа + +> Статус: `draft` · Заповнити перед першим релізом. + +Порти, внутрішні адреси, firewall, маршрути між сервісами. + +## Мапа портів + +_TODO_ + +## Внутрішня адресація + +_TODO_ + +## Firewall + +_TODO_ diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 0000000..ebdb304 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,17 @@ +# Огляд сервісів + +> Статус: `draft` · Заповнити перед першим релізом. + +Які сервіси розгорнуто, на яких машинах, як вони повʼязані. Топологія інфраструктури. + +## Перелік сервісів + +_TODO_ + +## Топологія + +_TODO_ + +## Залежності між сервісами + +_TODO_ diff --git a/docs/provisioning.md b/docs/provisioning.md new file mode 100644 index 0000000..95ec1d8 --- /dev/null +++ b/docs/provisioning.md @@ -0,0 +1,17 @@ +# Провіженинг хоста + +> Статус: `draft` · Заповнити перед першим релізом. + +Як із нуля підняти Gentoo-хост, готовий для розгортання сервісів. + +## Базова система + +_TODO_ + +## USE-прапорці та пакети + +_TODO_ + +## Користувачі та права + +_TODO_ diff --git a/garage/README.md b/garage/README.md new file mode 100644 index 0000000..bec4629 --- /dev/null +++ b/garage/README.md @@ -0,0 +1,13 @@ +# garage + +> Статус: `draft` · Заповнити перед першим релізом. + +S3-сумісне обʼєктне сховище (self-hosted). Рішення — [ADR-0005](https://git.uid.net.ua/uid.news/documentation/decisions/0005-garage-for-object-storage.md). + +## Роль у системі + +_TODO_ + +## Для чого використовується (медіа тощо) + +_TODO_ diff --git a/garage/conf/README.md b/garage/conf/README.md new file mode 100644 index 0000000..2aaf5fb --- /dev/null +++ b/garage/conf/README.md @@ -0,0 +1,3 @@ +# garage — конфіги + +> `garage.toml` тощо. diff --git a/garage/docs.md b/garage/docs.md new file mode 100644 index 0000000..431e1ea --- /dev/null +++ b/garage/docs.md @@ -0,0 +1,21 @@ +# garage — налаштування та експлуатація + +> Статус: `draft` · Заповнити перед першим релізом. + +Бакети, ключі доступу, реплікація, інтеграція із застосунками. + +## Кластер та ноди + +_TODO_ + +## Бакети + +_TODO_ + +## Ключі доступу + +_TODO_ + +## Бекапи + +_TODO_ diff --git a/llama-cpp/README.md b/llama-cpp/README.md new file mode 100644 index 0000000..03aff04 --- /dev/null +++ b/llama-cpp/README.md @@ -0,0 +1,14 @@ +# llama.cpp + +> Статус: `draft` + +У системі **два окремі інстанси** llama.cpp із різними моделями, параметрами +запуску та портами. Це головне джерело плутанини — не змішувати. + +| Інстанс | Модель | Режим | Призначення | +|---|---|---|---| +| [embeddings](embeddings/docs.md) | bge-m3-fp16 | `--embedding` | Векторизація для пошуку | +| [translation-moderation](translation-moderation/docs.md) | _(уточнити)_ | генеративний | Переклад новин + AI-модерація | + +Backend-бік цих інтеграцій описано в +[backend/docs/ai-integration.md](https://git.uid.net.ua/uid.news/backend/docs/ai-integration.md). diff --git a/llama-cpp/embeddings/README.md b/llama-cpp/embeddings/README.md new file mode 100644 index 0000000..669ac01 --- /dev/null +++ b/llama-cpp/embeddings/README.md @@ -0,0 +1,3 @@ +# Інстанс векторизації + +> OpenRC init-скрипт та конфіг цього інстанса. diff --git a/llama-cpp/embeddings/docs.md b/llama-cpp/embeddings/docs.md new file mode 100644 index 0000000..946a658 --- /dev/null +++ b/llama-cpp/embeddings/docs.md @@ -0,0 +1,25 @@ +# llama.cpp — інстанс векторизації (bge-m3-fp16) + +> Статус: `draft` · Заповнити перед першим релізом. + +Інстанс для отримання ембедингів. Модель bge-m3 у fp16, режим `--embedding`. + +## Модель та формат (bge-m3-fp16) + +_TODO_ + +## Параметри запуску + +_TODO_ + +## Порт та контекст + +_TODO_ + +## Розмірність ембедингу (1024) + +_TODO_ + +## Навантаження та ресурси + +_TODO_ diff --git a/llama-cpp/translation-moderation/README.md b/llama-cpp/translation-moderation/README.md new file mode 100644 index 0000000..fd9b603 --- /dev/null +++ b/llama-cpp/translation-moderation/README.md @@ -0,0 +1,3 @@ +# Інстанс перекладу/модерації + +> OpenRC init-скрипт та конфіг цього інстанса. diff --git a/llama-cpp/translation-moderation/docs.md b/llama-cpp/translation-moderation/docs.md new file mode 100644 index 0000000..fa4cd21 --- /dev/null +++ b/llama-cpp/translation-moderation/docs.md @@ -0,0 +1,25 @@ +# llama.cpp — інстанс перекладу та модерації + +> Статус: `draft` · Заповнити перед першим релізом. + +Генеративний інстанс для перекладу новин та AI-модерації. Модель — уточнити. + +## Модель та формат + +_TODO_ + +## Параметри запуску + +_TODO_ + +## Порт та контекст + +_TODO_ + +## Промпти + +_TODO_ + +## Навантаження та ресурси + +_TODO_ diff --git a/nginx/README.md b/nginx/README.md new file mode 100644 index 0000000..9cbf6d7 --- /dev/null +++ b/nginx/README.md @@ -0,0 +1,13 @@ +# nginx + +> Статус: `draft` · Заповнити перед першим релізом. + +Роль nginx: reverse proxy, термінація TLS, віддача статики, маршрутизація на backend та frontend SSR. + +## Роль у системі + +_TODO_ + +## Структура конфігів + +_TODO_ diff --git a/nginx/conf/README.md b/nginx/conf/README.md new file mode 100644 index 0000000..6526ad6 --- /dev/null +++ b/nginx/conf/README.md @@ -0,0 +1,3 @@ +# nginx — конфіги + +> Тут лежать реальні конфіги або приклади (`*.conf`). diff --git a/nginx/docs.md b/nginx/docs.md new file mode 100644 index 0000000..683dbb4 --- /dev/null +++ b/nginx/docs.md @@ -0,0 +1,21 @@ +# nginx — маршрутизація та експлуатація + +> Статус: `draft` · Заповнити перед першим релізом. + +Що проксі на backend, що на frontend SSR, кешування, TLS, ліміти. + +## Маршрутизація + +_TODO_ + +## TLS + +_TODO_ + +## Кешування + +_TODO_ + +## Rate limiting + +_TODO_ diff --git a/openrc/README.md b/openrc/README.md new file mode 100644 index 0000000..16ab1ae --- /dev/null +++ b/openrc/README.md @@ -0,0 +1,21 @@ +# Конвенції OpenRC + +> Статус: `draft` · Заповнити перед першим релізом. + +Спільні конвенції для init-скриптів OpenRC усіх сервісів: структура, залежності (`depend`), змінні, логування. + +## Структура init-скрипта + +_TODO_ + +## Залежності (depend) + +_TODO_ + +## Змінні у /etc/conf.d + +_TODO_ + +## Логування + +_TODO_ diff --git a/postgresql/README.md b/postgresql/README.md new file mode 100644 index 0000000..c2b5773 --- /dev/null +++ b/postgresql/README.md @@ -0,0 +1,13 @@ +# PostgreSQL + +> Статус: `draft` · Заповнити перед першим релізом. + +Роль PostgreSQL: основне сховище даних із розширенням pgvector для векторного пошуку. + +## Роль у системі + +_TODO_ + +## Версія та розширення + +_TODO_ diff --git a/postgresql/conf/README.md b/postgresql/conf/README.md new file mode 100644 index 0000000..2f5a7a3 --- /dev/null +++ b/postgresql/conf/README.md @@ -0,0 +1,3 @@ +# PostgreSQL — конфіги + +> `postgresql.conf`, `pg_hba.conf` тощо. diff --git a/postgresql/docs.md b/postgresql/docs.md new file mode 100644 index 0000000..90ae108 --- /dev/null +++ b/postgresql/docs.md @@ -0,0 +1,21 @@ +# PostgreSQL — налаштування та експлуатація + +> Статус: `draft` · Заповнити перед першим релізом. + +Тюнінг, розширення pgvector, налаштування під векторний пошук, бекапи, реплікація. + +## Основні параметри + +_TODO_ + +## Розширення pgvector + +_TODO_ + +## Тюнінг під векторний пошук + +_TODO_ + +## Бекапи та відновлення + +_TODO_