diff --git a/.dockerignore b/.dockerignore
index ea158e2..9acfd19 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -2,6 +2,10 @@
.gitignore
.gitattributes
+# секреты локального окружения (в образ не попадают)
+.env
+.env.*
+
# venv / кеши
.venv
.venv11
diff --git a/.env.example b/.env.example
index cbecffc..3c5fab6 100644
--- a/.env.example
+++ b/.env.example
@@ -42,3 +42,6 @@ CLICKHOUSE_PASSWORD=
ANALYTICS_BATCH_SIZE=200
ANALYTICS_FLUSH_INTERVAL=5.0
ANALYTICS_BUFFER_MAX=5000
+
+# Админка (FastAPI, Блок 4). Порт на loopback хоста для docker compose.
+ADMIN_HTTP_PORT=8000
diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml
index 22d6653..a58030d 100644
--- a/.gitea/workflows/ci.yml
+++ b/.gitea/workflows/ci.yml
@@ -13,7 +13,8 @@ concurrency:
env:
REGISTRY: git.mpakosrv.ru
- IMAGE_NAME: mpakobecex/dispelevilbot-bot
+ IMAGE_NAME_BOT: mpakobecex/dispelevilbot-bot
+ IMAGE_NAME_ADMIN: mpakobecex/dispelevilbot-admin
jobs:
lint-test:
@@ -40,16 +41,22 @@ jobs:
- uses: actions/checkout@v4
- name: Логин в Gitea Registry
run: echo "${{ secrets.REGISTRY_TOKEN }}" | docker login "$REGISTRY" -u "${{ secrets.REGISTRY_USER }}" --password-stdin
- - name: Сборка и публикация образа
+ - name: Сборка и публикация образов
run: |
set -e
- IMAGE="$REGISTRY/$IMAGE_NAME"
- SHA="${GITHUB_SHA:-unknown}"
- SHORT_SHA="$(echo "$SHA" | cut -c1-12)"
+ SHORT_SHA="$(echo "${GITHUB_SHA:-unknown}" | cut -c1-12)"
VERSION="$(sed -n 's/^__version__ = "\(.*\)"/\1/p' common/version.py)"
- TAGS="$IMAGE:$SHORT_SHA $IMAGE:latest"
- if [ -n "$VERSION" ]; then TAGS="$TAGS $IMAGE:$VERSION"; fi
- ARGS=""
- for t in $TAGS; do ARGS="$ARGS -t $t"; done
- docker build $ARGS .
- for t in $TAGS; do docker push "$t"; done
+
+ build_push() {
+ image="$1"
+ dockerfile="$2"
+ tags="$image:$SHORT_SHA $image:latest"
+ if [ -n "$VERSION" ]; then tags="$tags $image:$VERSION"; fi
+ args=""
+ for t in $tags; do args="$args -t $t"; done
+ docker build $args -f "$dockerfile" .
+ for t in $tags; do docker push "$t"; done
+ }
+
+ build_push "$REGISTRY/$IMAGE_NAME_BOT" Dockerfile
+ build_push "$REGISTRY/$IMAGE_NAME_ADMIN" admin/Dockerfile
diff --git a/DEPLOY.md b/DEPLOY.md
index 443b309..161787c 100644
--- a/DEPLOY.md
+++ b/DEPLOY.md
@@ -21,6 +21,7 @@ cp env/test.env.example env/test.env
Порт ClickHouse на хосте (`CLICKHOUSE_HTTP_PORT`) у контуров должен различаться:
`prod` — `8123`, `test` — `8124` (иначе контейнеры конфликтуют на одной VPS).
+Порт админки (`ADMIN_HTTP_PORT`) — так же: `prod` — `8000`, `test` — `8001`.
## 3. Логин в registry (если пакет приватный)
@@ -52,7 +53,8 @@ docker compose -p test --env-file env/test.env -f docker-compose.prod.yml logs -
2. `migrate` (**Flyway**) накатывает миграции из `sql/` — для пустой БД с нуля;
3. `clickhouse` поднимается и применяет `clickhouse/init/001_events.sql` —
**только при первой инициализации** пустого data-каталога;
-4. `bot` стартует (`Запуск DispelEvilBot v<версия> (APP_ENV=...)`), аналитика и рассылки — в нём же.
+4. `bot` стартует (`Запуск DispelEvilBot v<версия> (APP_ENV=...)`), аналитика и рассылки — в нём же;
+5. `admin` стартует и отвечает на `GET /healthz` (порт на loopback хоста).
Проверка контура (сервисы, миграции, Postgres, ClickHouse):
@@ -79,6 +81,21 @@ docker compose -p test --env-file env/test.env -f docker-compose.prod.yml exec -
Изменения схемы: `clickhouse/init/*.sql` применяются лишь на пустом data-каталоге,
поэтому на существующем контуре DDL нужно применить вручную (`make ch E=...`).
+## Админка (FastAPI)
+
+Сервис `admin` — отдельный образ `mpakobecex/dispelevilbot-admin`, общий пакет `common`.
+Наружу пока **не публикуется**: только loopback хоста (`127.0.0.1:${ADMIN_HTTP_PORT}`).
+Домен и TLS появятся вместе с входом через Telegram (Блоки 2.4/4.2).
+
+```bash
+# проверка живости
+curl -s http://127.0.0.1:8001/healthz # test
+curl -s http://127.0.0.1:8000/healthz # prod
+```
+
+Локально без Docker: `pip install -r requirements-admin.txt && python -m admin`
+(по умолчанию `0.0.0.0:8000`, переопределяется `ADMIN_HOST`/`ADMIN_PORT`).
+
## Бэкап событий (забирает домашний сервер)
Сырые события живут на VPS ограниченное время: раз в сутки домашний сервер **сам забирает**
diff --git a/README.md b/README.md
index 637aca0..0f3a42a 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ Telegram-бот клана Dispel Evil (aiogram 3 + Postgres). Монорепо
```
common/ # общий пакет: config, logging, db, repositories, models, texts, analytics
bot/ # сервис бота: handlers, services, keyboards, middlewares, notifications
+admin/ # сервис админки: FastAPI + Jinja2/HTMX (Блок 4), свой Dockerfile
sql/ # миграции Flyway (V__*.sql, R__*.sql)
clickhouse/ # init-скрипты ClickHouse (схема аналитики)
docs/ # документация (docs/events.md — события аналитики)
@@ -43,6 +44,9 @@ APP_ENV=prod python -m bot # prod
или через `./start.sh` (режим берётся из `APP_ENV`).
+Админка (FastAPI) запускается отдельным процессом: `python -m admin` (зависимости —
+`requirements-admin.txt`), по умолчанию слушает `0.0.0.0:8000`, проверка живучести — `GET /healthz`.
+
## База данных
Схема управляется миграциями **Flyway** в `sql/` (`V__*.sql` — versioned, `R__*.sql` — repeatable).
@@ -66,13 +70,17 @@ APP_ENV=prod python -m bot # prod
## Docker
-Локальный запуск (postgres + migrate + clickhouse + bot):
+Локальный запуск (postgres + migrate + clickhouse + bot + admin):
```bash
cp .env.example .env # заполнить
docker compose up --build
```
+CI собирает два образа: `dispelevilbot-bot` и `dispelevilbot-admin`. Админка в compose
+публикуется только на loopback (`127.0.0.1:${ADMIN_HTTP_PORT}`), наружу выйдет вместе
+с доменом и TLS (Блок 2.4/4.2).
+
Прод/test-контуры — один `docker-compose.prod.yml`, разделяются Compose-проектом и env-файлом:
```bash
@@ -104,7 +112,7 @@ make backup E=test # на домашнем сервере: ./scripts/clickho
## Версионирование
-- Единый источник версии — `common/version.py` (`__version__`), текущая — `0.3.9`.
+- Единый источник версии — `common/version.py` (`__version__`), текущая — `0.4.0`.
- Схема — SemVer-подобная (`MAJOR.MINOR.PATCH`); git-тег = `v` + версия (`v0.1`).
- Docker-образы тегируются версией (Блок 2), события ClickHouse получают `bot_version` (Блок 3).
- Выпуск: изменить `common/version.py` → коммит → аннотированный тег `vX.Y` → `git push --tags`.
diff --git a/admin/Dockerfile b/admin/Dockerfile
new file mode 100644
index 0000000..effa427
--- /dev/null
+++ b/admin/Dockerfile
@@ -0,0 +1,29 @@
+# syntax=docker/dockerfile:1
+# Образ сервиса админки (FastAPI + Jinja2/HTMX).
+FROM python:3.12-slim
+
+ENV PYTHONUNBUFFERED=1 \
+ PYTHONDONTWRITEBYTECODE=1 \
+ PIP_NO_CACHE_DIR=1 \
+ PIP_DISABLE_PIP_VERSION_CHECK=1
+
+WORKDIR /app
+
+# Непривилегированный пользователь
+RUN useradd --create-home --uid 1000 app
+
+COPY requirements-admin.txt ./
+RUN pip install --no-cache-dir -r requirements-admin.txt
+
+COPY common ./common
+COPY admin ./admin
+
+USER app
+
+EXPOSE 8000
+
+# Живость процесса: HTTP-проверка /healthz (порт берётся из ADMIN_PORT).
+HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \
+ CMD python -c "import os,urllib.request; urllib.request.urlopen('http://127.0.0.1:'+os.environ.get('ADMIN_PORT','8000')+'/healthz', timeout=3)"
+
+CMD ["python", "-m", "admin"]
diff --git a/admin/__init__.py b/admin/__init__.py
new file mode 100644
index 0000000..6592a4e
--- /dev/null
+++ b/admin/__init__.py
@@ -0,0 +1,4 @@
+"""Сервис админки DispelEvilBot (FastAPI + HTMX).
+
+Отдельный процесс/образ; общий код — пакет ``common``. Запуск: ``python -m admin``.
+"""
diff --git a/admin/__main__.py b/admin/__main__.py
new file mode 100644
index 0000000..d8adde1
--- /dev/null
+++ b/admin/__main__.py
@@ -0,0 +1,31 @@
+"""Точка входа админки: python -m admin"""
+
+from __future__ import annotations
+
+import logging
+
+import uvicorn
+
+from common.config import get_admin_settings
+from common.logging_config import setup_logging
+
+logger = logging.getLogger(__name__)
+
+
+def main() -> None:
+ """Запустить uvicorn с приложением из ``admin.app``."""
+ setup_logging(logging.INFO)
+ settings = get_admin_settings()
+ logger.info("Запуск админки (APP_ENV=%s) на %s:%s", settings.app_env, settings.admin_host, settings.admin_port)
+ # log_config=None — чтобы uvicorn не перетирал единый формат логов.
+ uvicorn.run(
+ "admin.app:create_app",
+ factory=True,
+ host=settings.admin_host,
+ port=settings.admin_port,
+ log_config=None,
+ )
+
+
+if __name__ == "__main__":
+ main()
diff --git a/admin/app.py b/admin/app.py
new file mode 100644
index 0000000..89378ab
--- /dev/null
+++ b/admin/app.py
@@ -0,0 +1,40 @@
+"""Создание FastAPI-приложения админки."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from fastapi import FastAPI
+from fastapi.templating import Jinja2Templates
+
+from admin.routes import health, pages
+from common import __version__
+from common.config import AdminSettings, get_admin_settings
+from common.logging_config import setup_logging
+
+BASE_DIR = Path(__file__).resolve().parent
+TEMPLATES_DIR = BASE_DIR / "templates"
+
+
+def create_app(settings: AdminSettings | None = None) -> FastAPI:
+ """Собрать приложение: настройки, шаблоны, роутеры.
+
+ Настройки можно передать явно (тесты); по умолчанию читаются из окружения.
+ """
+ setup_logging()
+ settings = settings or get_admin_settings()
+
+ app = FastAPI(
+ title="DispelEvilBot Admin",
+ version=__version__,
+ # Swagger/OpenAPI наружу пока не нужны: админка закрыта логином (Блок 4.2).
+ docs_url=None,
+ redoc_url=None,
+ openapi_url=None,
+ )
+ app.state.settings = settings
+ app.state.templates = Jinja2Templates(directory=str(TEMPLATES_DIR))
+
+ app.include_router(health.router)
+ app.include_router(pages.router)
+ return app
diff --git a/admin/routes/__init__.py b/admin/routes/__init__.py
new file mode 100644
index 0000000..f4723a8
--- /dev/null
+++ b/admin/routes/__init__.py
@@ -0,0 +1 @@
+"""Роутеры админки."""
diff --git a/admin/routes/health.py b/admin/routes/health.py
new file mode 100644
index 0000000..fc5228e
--- /dev/null
+++ b/admin/routes/health.py
@@ -0,0 +1,16 @@
+"""Служебные эндпоинты: healthcheck для Docker и мониторинга."""
+
+from __future__ import annotations
+
+from fastapi import APIRouter, Request
+
+from common import __version__
+
+router = APIRouter(tags=["service"])
+
+
+@router.get("/healthz")
+async def healthz(request: Request) -> dict[str, str]:
+ """Вернуть состояние сервиса (используется healthcheck'ом контейнера)."""
+ settings = request.app.state.settings
+ return {"status": "ok", "version": __version__, "app_env": settings.app_env}
diff --git a/admin/routes/pages.py b/admin/routes/pages.py
new file mode 100644
index 0000000..9928a36
--- /dev/null
+++ b/admin/routes/pages.py
@@ -0,0 +1,34 @@
+"""HTML-страницы админки (серверный рендер Jinja2 + HTMX)."""
+
+from __future__ import annotations
+
+from fastapi import APIRouter, Request
+from fastapi.responses import HTMLResponse
+
+from common import __version__
+
+router = APIRouter(tags=["pages"])
+
+#: Разделы админки по плану Блока 4 (пока заглушки на главной).
+SECTIONS: tuple[tuple[str, str, str], ...] = (
+ ("messages", "Сообщения", "Тексты бота и предпросмотр с тегами {tag}"),
+ ("schedules", "Расписания", "Время рассылок, дни недели и шаблон"),
+ ("users", "Пользователи", "Ники, звания, баланс и подписка"),
+ ("logs", "Логи", "События из ClickHouse с фильтрами"),
+)
+
+
+@router.get("/", response_class=HTMLResponse)
+async def index(request: Request) -> HTMLResponse:
+ """Главная страница: версия, окружение и список будущих разделов."""
+ templates = request.app.state.templates
+ settings = request.app.state.settings
+ return templates.TemplateResponse(
+ request=request,
+ name="index.html",
+ context={
+ "version": __version__,
+ "app_env": settings.app_env,
+ "sections": SECTIONS,
+ },
+ )
diff --git a/admin/templates/base.html b/admin/templates/base.html
new file mode 100644
index 0000000..5f68b25
--- /dev/null
+++ b/admin/templates/base.html
@@ -0,0 +1,24 @@
+
+
+
+
+
+ {% block title %}Админка{% endblock %} — DispelEvilBot
+
+
+
+
+
+
+
+ {% block content %}{% endblock %}
+
+
+
+
+
diff --git a/admin/templates/index.html b/admin/templates/index.html
new file mode 100644
index 0000000..c794ee7
--- /dev/null
+++ b/admin/templates/index.html
@@ -0,0 +1,23 @@
+{% extends "base.html" %}
+
+{% block title %}Главная{% endblock %}
+
+{% block content %}
+Панель администрирования
+
+ Окружение: {{ app_env }}. Это каркас админки: разделы
+ появятся по мере готовности (Блок 4.1–4.3).
+
+
+
+ {% for key, title, description in sections %}
+
+
+
{{ title }}
+ скоро
+
+ {{ description }}
+
+ {% endfor %}
+