diff --git a/.cursor/rules/version-and-docs.mdc b/.cursor/rules/version-and-docs.mdc index deb92db..90f474a 100644 --- a/.cursor/rules/version-and-docs.mdc +++ b/.cursor/rules/version-and-docs.mdc @@ -20,4 +20,4 @@ alwaysApply: true 5. Не поднимать версию за косметические правки без изменения поведения. -Текущая базовая версия: **1.0.1**. +Текущая базовая версия: **1.0.2**. diff --git a/.gitignore b/.gitignore index 6e4266f..4808310 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ __pycache__/ *.py[cod] *$py.class + +# Секреты инстанса — только шаблон .env.example в репозитории +.env +.env.local +.env.*.local diff --git a/README.md b/README.md index 93aa6df..faff1a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Zilant / VOLK — Telegram poster и подписки -**Версия:** 1.0.1 ([`VERSION`](VERSION)) +**Версия:** 1.0.2 ([`VERSION`](VERSION)) Автоматическая публикация постов и событий в Telegram-канал, веб-редактор, бот подписок с сезонными deep link. @@ -23,7 +23,9 @@ sudo systemctl status testedit-git.service # UI :5006 sudo systemctl status runner.timer # hourly pipeline ``` -Конфигурация — `.env` (не коммитится). Ключевые переменные: `RELAY_URL`, `WEBHOOK_URL`, `SEASON`, `MDB_*`. +Конфигурация — скопируйте [`.env.example`](.env.example) в `.env` и заполните значения +(файл `.env` в git не коммитится). Ключевые переменные: `WORKMODE`, `RELAY_URL`, `WEBHOOK_URL`, `SEASON`, `MDB_*`. +Генерация секретов: `python tools/ops/genkey.py`. ## Пайплайн (ZILANT) diff --git a/VERSION b/VERSION index 7dea76e..6d7de6e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.0.1 +1.0.2 diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index d98a220..8d705ff 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -76,6 +76,13 @@ ## Конфигурация (.env) +Шаблон для нового инстанса: [`.env.example`](../.env.example). + +```bash +cp .env.example .env +# заполнить CHANGE_ME_*; секреты: python tools/ops/genkey.py +``` + | Переменная | Назначение | |------------|------------| | `WORKMODE` | `ZILANT` или `VOLK` | @@ -84,6 +91,9 @@ | `WEBHOOK_URL`, `WEBHOOK_SECRET` | Доставка апдейтов боту | | `MDB_*`, `MDBASE` | MariaDB | | `POSTER_BOT_TOKEN`, `RESPONDER_BOT_TOKEN` | Токены ботов | +| `PZK_PREFIX`, `EVT_PREFIX`, `DESC_PREFIX` | Ссылки ZILANT | +| `VOLK_*` | API VOLK (при `WORKMODE=VOLK`) | +| `RA_KEY`, `RA_MODEL` | RouterAI для shortname | ## Карта файлов diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 3596c07..6c89216 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -3,6 +3,17 @@ Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/). Версия проекта — в файле [`VERSION`](../VERSION) (SemVer). +## [1.0.2] - 2026-08-30 + +### Added + +- Шаблон окружения [`.env.example`](../.env.example) для ZILANT и VOLK (секреты — плейсхолдеры). +- `.env` добавлен в [`.gitignore`](../.gitignore). + +### Documentation + +- README и `docs/ARCHITECTURE.md`: копирование `.env.example` → `.env` при настройке инстанса. + ## [1.0.1] - 2026-08-30 ### Changed diff --git a/docs/volk-mode.md b/docs/volk-mode.md index df347b7..d55d756 100644 --- a/docs/volk-mode.md +++ b/docs/volk-mode.md @@ -1,6 +1,6 @@ # Режим VOLK -Режим включается в `.env`: +Режим включается в `.env` (скопируйте из [`.env.example`](../.env.example)): ```env WORKMODE = "VOLK"