Compare commits
4 Commits
4fe1bb44e4
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 73fb5a3f5f | |||
| 144a3eb82a | |||
| 36e7747573 | |||
| 30f7dc0ce2 |
@@ -147,7 +147,8 @@ jobs:
|
||||
DRY_RUN_FLAG=""
|
||||
fi
|
||||
|
||||
if docker compose \${DRY_RUN_FLAG} -f "docker-compose-${REF_NAME}.yml" up -d --remove-orphans > ${DEPLOY_LOG_FILE} 2>&1; then
|
||||
if docker compose \${DRY_RUN_FLAG} -f "docker-compose-${REF_NAME}.yml" pull > ${DEPLOY_LOG_FILE} 2>&1 && \
|
||||
docker compose \${DRY_RUN_FLAG} -f "docker-compose-${REF_NAME}.yml" up -d --remove-orphans >> ${DEPLOY_LOG_FILE} 2>&1; then
|
||||
curl -s -X POST "https://api.telegram.org/bot${TELEGRAM_TOKEN}/sendMessage" \
|
||||
--proxy "${PROXY_URL}" \
|
||||
-d "chat_id=${TELEGRAM_CHAT}" \
|
||||
@@ -168,4 +169,4 @@ jobs:
|
||||
' > /dev/null 2>&1 &
|
||||
EOT
|
||||
|
||||
echo "New containers will be started after 5 seconds"
|
||||
echo "New containers will be started after 5 seconds"
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
# AGENTS.md
|
||||
|
||||
Инструкции для AI-агентов и автоматизации, работающих с этим репозиторием.
|
||||
|
||||
## Форма проекта
|
||||
|
||||
Это Docker Compose инфраструктурный репозиторий. Основные source-файлы:
|
||||
|
||||
- `docker-compose.yml`
|
||||
- `.env.example`
|
||||
- `.gitignore`
|
||||
- `.gitea/workflows/*.yaml`
|
||||
- `.gitea/actions/*`
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
|
||||
Текущие service aliases в Compose:
|
||||
|
||||
```text
|
||||
prx
|
||||
pwd
|
||||
mon
|
||||
mon-agent
|
||||
cld
|
||||
git
|
||||
git-runner
|
||||
sup-hbbs
|
||||
sup-hbbr
|
||||
```
|
||||
|
||||
Сохраняйте эти короткие aliases, если пользователь явно не попросил переименовать сервисы и не подтвердил учет deploy-impact.
|
||||
|
||||
## Секреты и runtime-данные
|
||||
|
||||
Не читайте, не выводите, не пересказывайте, не копируйте и не коммитьте реальные секреты или runtime-данные.
|
||||
|
||||
Считайте эти пути sensitive или local-only:
|
||||
|
||||
- `.env`
|
||||
- `secrets/`
|
||||
- `data/`
|
||||
- database-файлы вроде `*.sqlite3`, `*.sqlite3-shm`, `*.sqlite3-wal`
|
||||
- private keys и сгенерированные service credentials
|
||||
- certificates и letsencrypt data
|
||||
|
||||
Используйте `.env.example`, `docker-compose.yml` и workflow-файлы как source of truth для имен переменных и секретов. Если задача требует просмотра реальных secret values или runtime-данных, остановитесь и запросите явное разрешение пользователя.
|
||||
|
||||
## Правила изменений
|
||||
|
||||
- Держите изменения узко привязанными к запрошенному infrastructure-поведению.
|
||||
- Не выполняйте destructive-операции против `data/`, `secrets/`, Docker volumes или корня проекта без явного разрешения пользователя.
|
||||
- Не запускайте `docker compose down -v`, volume pruning, recursive deletion, database migrations или service resets, если пользователь не запросил именно это.
|
||||
- При добавлении или изменении Compose-переменной обновляйте `.env.example`, `README.md` и Gitea deploy workflow, если значение нужно при деплое.
|
||||
- При добавлении или изменении Compose-секрета обновляйте блок `secrets:`, создание секретов в deploy workflow, `README.md` и соответствующий service environment.
|
||||
- Сохраняйте стиль YAML: короткие service aliases, single quotes там, где они уже используются, и существующую indentation-схему.
|
||||
- Избегайте unrelated formatting churn в workflow и Compose-файлах.
|
||||
|
||||
## Валидация
|
||||
|
||||
Для Compose-изменений запускайте:
|
||||
|
||||
```sh
|
||||
docker compose config
|
||||
```
|
||||
|
||||
Для изменений deploy workflow проверяйте затронутые `.gitea/workflows/*.yaml` и подтверждайте, что нужные variables/secrets описаны в `README.md`.
|
||||
|
||||
Для documentation-only изменений проверьте, что:
|
||||
|
||||
- service names совпадают с `docker-compose.yml`;
|
||||
- environment variables совпадают с `.env.example`;
|
||||
- secret filenames совпадают с Compose-блоком `secrets:`;
|
||||
- реальные secret values и runtime-данные не попали в документацию.
|
||||
|
||||
## Операционный контекст
|
||||
|
||||
Деплой запускается вручную через Gitea Actions. Deploy workflow подключается к серверу по SSH, записывает `.env` и `secrets/*.txt`, опционально делает backup удаленного `data/` и стартует контейнеры командой:
|
||||
|
||||
```sh
|
||||
docker compose -f docker-compose-<ref>.yml up -d --remove-orphans
|
||||
```
|
||||
|
||||
Workflow может отправлять Telegram-уведомления и прикладывать deploy logs. Изменения deploy-поведения должны учитывать и remote shell commands, и documented Gitea variables/secrets.
|
||||
@@ -0,0 +1,98 @@
|
||||
# Changelog
|
||||
|
||||
Все заметные изменения в инфраструктурном репозитории описываются в этом файле.
|
||||
|
||||
Формат ведется вручную на русском языке. В changelog попадают изменения, которые влияют на состав сервисов, версии Docker images, деплой, backup/restore, переменные окружения, секреты и эксплуатационные правила.
|
||||
|
||||
## Будущие изменения
|
||||
|
||||
Пока нет.
|
||||
|
||||
## 2026-08-23
|
||||
|
||||
### Документация
|
||||
|
||||
- Добавлен `CHANGELOG.md` с историей заметных изменений по git history с начала репозитория.
|
||||
|
||||
## 2026-08-22
|
||||
|
||||
### Изменено
|
||||
|
||||
- Зафиксирована версия Vaultwarden: `vaultwarden/server:1.37.1` вместо `vaultwarden/server:latest`.
|
||||
- Deploy workflow теперь выполняет `docker compose pull` перед `docker compose up -d --remove-orphans`.
|
||||
- В `README.md` добавлено правило фиксировать версии stateful-сервисов и обновлять их отдельным изменением после просмотра release notes и backup.
|
||||
|
||||
### Исправлено
|
||||
|
||||
- Восстановлена совместимость Vaultwarden с актуальным расширением Bitwarden для браузера. Старый backend `1.36.0` не загружал хранилище в новом расширении.
|
||||
|
||||
### Документация
|
||||
|
||||
- Добавлен `README.md` с описанием сервисов, переменных, секретов, локальных операций, данных, деплоя и правил сопровождения.
|
||||
- Добавлен `AGENTS.md` с инструкциями для AI-агентов и автоматизации в этом репозитории.
|
||||
|
||||
## 2026-07-26
|
||||
|
||||
### Добавлено
|
||||
|
||||
- Добавлены сервисы RustDesk:
|
||||
- `sup-hbbs` для ID/rendezvous server;
|
||||
- `sup-hbbr` для relay server.
|
||||
- Для Nginx Proxy Manager открыты порты RustDesk: `21116/tcp`, `21116/udp`, `21117/tcp`.
|
||||
- Добавлена переменная `RUSTDESK_DOMAIN` в `.env.example` и deploy workflow.
|
||||
|
||||
## 2026-07-06
|
||||
|
||||
### Добавлено
|
||||
|
||||
- Добавлен healthcheck для `git-runner` через endpoint `http://127.0.0.1:9101/healthz`.
|
||||
|
||||
## 2026-07-05
|
||||
|
||||
### Изменено
|
||||
|
||||
- Backup-шаг deploy workflow стал опциональным через Gitea variable `DEPLOY_BACKUP_ENABLED`.
|
||||
- Режим dry-run для деплоя вынесен в Gitea variable `DEPLOY_DRY_RUN_ENABLED`.
|
||||
|
||||
## 2026-07-04
|
||||
|
||||
### Добавлено
|
||||
|
||||
- Deploy workflow переведен на полноценный Gitea Actions процесс:
|
||||
- checkout репозитория;
|
||||
- нормализация имени ref/branch;
|
||||
- настройка SSH-клиента;
|
||||
- создание удаленного `docker-compose-<ref>.yml`;
|
||||
- создание `.env` и файлов в `secrets/`;
|
||||
- запуск Compose на сервере;
|
||||
- Telegram-уведомления и отправка deploy log.
|
||||
- Добавлен workflow для проверки Telegram deploy bot.
|
||||
- Добавлен `.env.example` с базовыми переменными окружения.
|
||||
- Добавлен backup `data/` перед деплоем с хранением архивов в `backups/`.
|
||||
|
||||
### Изменено
|
||||
|
||||
- `DEPLOY_DIRECTORY` перенесен из secrets в Gitea variables.
|
||||
- Backup выполняется через `sudo`, чтобы избежать ошибок прав доступа к runtime-данным.
|
||||
- Исправлена передача пароля в `sudo` при backup.
|
||||
- Удален временный demo workflow и неиспользуемый action для экранирования Telegram-сообщений.
|
||||
- Идеи по развитию вынесены из репозитория в wiki.
|
||||
|
||||
## 2026-06-16
|
||||
|
||||
### Добавлено
|
||||
|
||||
- Создан начальный Docker Compose стек:
|
||||
- `prx` на `jc21/nginx-proxy-manager:2.15.1`;
|
||||
- `pwd` на `vaultwarden/server:latest`;
|
||||
- `mon` на `henrygd/beszel`;
|
||||
- `mon-agent` на `henrygd/beszel-agent`;
|
||||
- `cld` на `nextcloud:30.0.6`;
|
||||
- `git` на `docker.gitea.com/gitea:1.26.2`.
|
||||
- Добавлены bind mounts в `data/` для persistent-данных сервисов.
|
||||
- Добавлены Docker secrets для Vaultwarden и Beszel.
|
||||
- Добавлена сеть Compose `vbevdev`.
|
||||
- Добавлен `.gitignore` для локальных данных, секретов, `.env`, `.vscode` и `.DS_Store`.
|
||||
- Добавлен сервис `git-runner` на `gitea/act_runner:latest`.
|
||||
- Добавлен healthcheck для `git` и зависимость `git-runner` от здорового `git`.
|
||||
- Добавлен черновой deploy workflow для Gitea Actions.
|
||||
@@ -0,0 +1,159 @@
|
||||
# vbevdev
|
||||
|
||||
Self-hosted инфраструктурный стек, управляемый через Docker Compose.
|
||||
|
||||
Репозиторий содержит Compose-описание сервисов, workflow для деплоя и пример переменных окружения. Runtime-данные и секреты намеренно не хранятся в Git.
|
||||
|
||||
## Сервисы
|
||||
|
||||
| Сервис | Image | Назначение |
|
||||
| --- | --- | --- |
|
||||
| `prx` | `jc21/nginx-proxy-manager:2.15.1` | Nginx Proxy Manager для reverse proxy, HTTP/HTTPS и сертификатов. |
|
||||
| `pwd` | `vaultwarden/server:1.37.1` | Vaultwarden, менеджер паролей. |
|
||||
| `mon` | `henrygd/beszel` | Beszel monitoring hub. |
|
||||
| `mon-agent` | `henrygd/beszel-agent` | Beszel monitoring agent с доступом к Docker socket. |
|
||||
| `cld` | `nextcloud:30.0.6` | Nextcloud. |
|
||||
| `git` | `docker.gitea.com/gitea:1.26.2` | Gitea server. |
|
||||
| `git-runner` | `gitea/act_runner:latest` | Gitea Actions runner. |
|
||||
| `sup-hbbs` | `rustdesk/rustdesk-server:latest` | RustDesk ID/rendezvous server. |
|
||||
| `sup-hbbr` | `rustdesk/rustdesk-server:latest` | RustDesk relay server. |
|
||||
|
||||
Docker network по умолчанию называется `vbevdev`.
|
||||
|
||||
## Конфигурация
|
||||
|
||||
Создайте локальный `.env` из `.env.example` и задайте значения для своей среды:
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Обязательные переменные:
|
||||
|
||||
```sh
|
||||
BESZEL_HUB_URL=http://mon.localhost
|
||||
NEXTCLOUD_DOMAIN=cld.localhost
|
||||
GITEA_URL=http://git:3000
|
||||
RUSTDESK_DOMAIN=sup.local
|
||||
```
|
||||
|
||||
Перед запуском сервисов, которым нужны секреты, создайте файлы:
|
||||
|
||||
```text
|
||||
secrets/vaultwarden_admin_token.txt
|
||||
secrets/beszel_agent_key.txt
|
||||
secrets/beszel_agent_token.txt
|
||||
secrets/gitea_runner_registration_token.txt
|
||||
```
|
||||
|
||||
Рекомендуемые права:
|
||||
|
||||
```sh
|
||||
chmod 700 secrets
|
||||
chmod 600 secrets/*.txt
|
||||
```
|
||||
|
||||
Не коммитьте `.env`, `secrets/` и `data/`. В них находятся локальная конфигурация, credentials, базы данных, пользовательские файлы, сгенерированные ключи, сертификаты и другое runtime-состояние.
|
||||
|
||||
## Локальные операции
|
||||
|
||||
Проверить Compose-файл:
|
||||
|
||||
```sh
|
||||
docker compose config
|
||||
```
|
||||
|
||||
Запустить или обновить стек:
|
||||
|
||||
```sh
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Посмотреть состояние и логи:
|
||||
|
||||
```sh
|
||||
docker compose ps
|
||||
docker compose logs -f <service>
|
||||
```
|
||||
|
||||
Скачать новые images и пересоздать контейнеры:
|
||||
|
||||
```sh
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Для stateful-сервисов с данными в `data/` фиксируйте конкретные версии images вместо `latest`. Обновление версии делайте отдельным изменением после просмотра release notes и backup соответствующей директории в `data/`.
|
||||
|
||||
Остановить стек без удаления runtime-данных:
|
||||
|
||||
```sh
|
||||
docker compose down
|
||||
```
|
||||
|
||||
## Данные
|
||||
|
||||
Persistent-данные контейнеров монтируются в `./data`:
|
||||
|
||||
```text
|
||||
data/nginx-proxy-manager/
|
||||
data/vaultwarden/
|
||||
data/beszel/
|
||||
data/nextcloud/
|
||||
data/gitea/
|
||||
data/rustdesk/
|
||||
```
|
||||
|
||||
Эта директория является runtime-состоянием, а не исходным кодом. Делайте backup перед destructive Docker-командами, изменением volume, миграциями и обновлениями stateful-сервисов.
|
||||
|
||||
## Деплой
|
||||
|
||||
Деплой описан в `.gitea/workflows/deploy.yaml` и запускается вручную через `workflow_dispatch`.
|
||||
|
||||
Workflow деплоя:
|
||||
|
||||
1. Забирает репозиторий.
|
||||
2. Нормализует имя ref/branch для имени удаленного Compose-файла.
|
||||
3. Настраивает SSH через `.gitea/actions/configure-ssh-client`.
|
||||
4. Опционально создает архив `data/`, если `DEPLOY_BACKUP_ENABLED` равен `true`.
|
||||
5. Копирует `docker-compose.yml` на сервер как `docker-compose-<ref>.yml`.
|
||||
6. Создает на сервере `.env` и `secrets/*.txt` из Gitea variables и secrets.
|
||||
7. Скачивает images и запускает `docker compose -f docker-compose-<ref>.yml up -d --remove-orphans`.
|
||||
8. Отправляет Telegram-уведомление об успехе или ошибке и прикладывает deploy log.
|
||||
|
||||
Используемые Gitea variables:
|
||||
|
||||
```text
|
||||
DEPLOY_DIRECTORY
|
||||
DEPLOY_BACKUP_ENABLED
|
||||
DEPLOY_DRY_RUN_ENABLED
|
||||
BESZEL_HUB_URL
|
||||
GIT_URL
|
||||
NEXTCLOUD_DOMAIN
|
||||
RUSTDESK_DOMAIN
|
||||
```
|
||||
|
||||
Используемые Gitea secrets:
|
||||
|
||||
```text
|
||||
SSH_HOST
|
||||
SSH_USERNAME
|
||||
SSH_PASSWORD
|
||||
BESZEL_AGENT_KEY
|
||||
BESZEL_AGENT_TOKEN
|
||||
RUNNER_REGISTRATION_TOKEN
|
||||
VAULTWARDEN_ADMIN_TOKEN
|
||||
TELEGRAM_DEPLOY_BOT_TOKEN
|
||||
TELEGRAM_DEPLOY_CHAT_ID
|
||||
PROXY_URL
|
||||
```
|
||||
|
||||
Workflow `.gitea/workflows/test_telegram_deploy_bot.yaml` можно запускать вручную для проверки Telegram-уведомлений через настроенный proxy.
|
||||
|
||||
## Сопровождение
|
||||
|
||||
- Запускайте `docker compose config` после изменений в `docker-compose.yml`.
|
||||
- Держите `.env.example` синхронизированным с переменными, которые использует Compose.
|
||||
- Держите Gitea variables/secrets синхронизированными с `.gitea/workflows/deploy.yaml`.
|
||||
- Делайте backup `data/` перед обновлениями, сменой images, изменением volumes и миграциями.
|
||||
- Перед изменением pinned image versions проверяйте release notes stateful-сервисов.
|
||||
+102
@@ -0,0 +1,102 @@
|
||||
# Roadmap
|
||||
|
||||
Планируемые улучшения инфраструктурного репозитория. Файл фиксирует будущие работы, эксплуатационные риски и технический долг.
|
||||
|
||||
`CHANGELOG.md` описывает уже сделанные изменения, а этот файл хранит то, что еще нужно спланировать или выполнить.
|
||||
|
||||
## Высокий приоритет
|
||||
|
||||
### Обновить Nextcloud с EOL-версии
|
||||
|
||||
- Текущая версия: `nextcloud:30.0.6`.
|
||||
- Риск: ветка Nextcloud 30 достигла EOL и не получает исправления безопасности.
|
||||
- Что сделать:
|
||||
- изучить upgrade path и release notes Nextcloud;
|
||||
- сделать backup `data/nextcloud/`;
|
||||
- проверить совместимость используемых apps;
|
||||
- обновляться по поддерживаемому пути между major versions;
|
||||
- после обновления проверить web UI, `occ status`, фоновые задачи и healthcheck.
|
||||
|
||||
### Обновить Gitea из-за security advisory
|
||||
|
||||
- Текущая версия: `docker.gitea.com/gitea:1.26.2`.
|
||||
- Риск: для Gitea `<= 1.26.4` опубликован SSRF advisory, patched version указана как `1.27.0`.
|
||||
- Что сделать:
|
||||
- изучить release notes Gitea `1.27.0+`;
|
||||
- сделать backup `data/gitea/`;
|
||||
- обновить image version в `docker-compose.yml`;
|
||||
- проверить web UI, git clone/push, Actions и healthcheck.
|
||||
|
||||
### Переделать backup перед деплоем
|
||||
|
||||
- Текущее поведение: workflow архивирует весь `data/` в `backups/` на том же диске.
|
||||
- Риск: backup может падать из-за нехватки места до начала деплоя.
|
||||
- Что сделать:
|
||||
- добавить preflight-проверку свободного места;
|
||||
- чистить старые backups до создания нового архива;
|
||||
- рассмотреть backup только затронутого service data вместо всего `data/`;
|
||||
- рассмотреть off-host backup или streaming backup на другую машину;
|
||||
- документировать ручной backup/restore для отдельных сервисов.
|
||||
|
||||
## Средний приоритет
|
||||
|
||||
### Закрепить оставшиеся Docker image versions
|
||||
|
||||
- Сейчас floating images остаются у:
|
||||
- `henrygd/beszel`;
|
||||
- `henrygd/beszel-agent`;
|
||||
- `gitea/act_runner:latest`;
|
||||
- `rustdesk/rustdesk-server:latest`.
|
||||
- Риск: деплой может неожиданно подтянуть несовместимую версию или, наоборот, не обновиться предсказуемо.
|
||||
- Что сделать:
|
||||
- подобрать актуальные стабильные версии;
|
||||
- закрепить tags в `docker-compose.yml`;
|
||||
- обновить `README.md` и `CHANGELOG.md`;
|
||||
- для stateful-сервисов делать отдельные коммиты и backup перед деплоем.
|
||||
|
||||
### Пересмотреть безопасность Gitea Actions runner
|
||||
|
||||
- Текущее поведение: `git-runner` имеет доступ к `/var/run/docker.sock`.
|
||||
- Риск: доступ к Docker socket фактически дает workflow root-equivalent доступ к хосту.
|
||||
- Что сделать:
|
||||
- явно определить trust boundary для Actions;
|
||||
- ограничить запуск workflow только доверенными репозиториями/пользователями;
|
||||
- рассмотреть отдельный runner host или VM;
|
||||
- рассмотреть rootless/isolated runner setup, если это совместимо с нужными jobs.
|
||||
|
||||
### Уйти от password-based SSH deploy
|
||||
|
||||
- Текущее поведение: workflow использует `sshpass` и `sudo -S`.
|
||||
- Риск: парольный deploy хуже аудируется и более хрупкий, чем key-based доступ с ограниченными правами.
|
||||
- Что сделать:
|
||||
- завести отдельного deploy user;
|
||||
- перейти на SSH key;
|
||||
- ограничить sudoers только нужными командами;
|
||||
- убрать передачу sudo password из workflow.
|
||||
|
||||
## Низкий приоритет
|
||||
|
||||
### Добавить healthcheck для сервисов без проверки готовности
|
||||
|
||||
- Кандидаты:
|
||||
- `pwd`;
|
||||
- `sup-hbbs`;
|
||||
- `sup-hbbr`.
|
||||
- Цель: после деплоя видеть, что сервис не просто запущен, а реально отвечает.
|
||||
|
||||
### Почистить test Telegram workflow
|
||||
|
||||
- В `test_telegram_deploy_bot.yaml` есть неиспользуемая переменная `MESSAGE`, которая ссылается на несуществующий `steps.prepare_message`.
|
||||
- Риск низкий: workflow сейчас не использует эту переменную, но она путает чтение и сопровождение.
|
||||
|
||||
### Разобраться с использованием диска
|
||||
|
||||
- После неудачной попытки backup занятое место на диске выросло.
|
||||
- Первичные наблюдения:
|
||||
- `backups/` не содержит крупного архива;
|
||||
- `lsof +L1` не показал большого удаленного файла;
|
||||
- Docker images занимают заметный объем, но не должны были измениться, если workflow упал до Docker-шагов.
|
||||
- Что сделать:
|
||||
- найти крупные каталоги через `du -xhd 1`;
|
||||
- проверить `/var`, `/tmp`, Docker storage и filesystem reserve;
|
||||
- только после диагностики решать, что можно чистить.
|
||||
+2
-2
@@ -19,7 +19,7 @@ services:
|
||||
timeout: 3s
|
||||
|
||||
pwd:
|
||||
image: 'vaultwarden/server:latest'
|
||||
image: 'vaultwarden/server:1.37.1'
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./data/vaultwarden:/data
|
||||
@@ -138,4 +138,4 @@ secrets:
|
||||
file: secrets/beszel_agent_token.txt
|
||||
gitea_runner_registration_token:
|
||||
file: secrets/gitea_runner_registration_token.txt
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user