9 Commits

Author SHA1 Message Date
vbevdev 36e7747573 Pin vaultwarden image version 2026-08-22 23:57:37 +03:00
vbevdev 30f7dc0ce2 Add project documentation 2026-08-22 23:42:47 +03:00
vbevdev 4fe1bb44e4 RustDesk
Reviewed-on: #4
2026-07-26 21:43:58 +00:00
vbevdev 66ee081c80 healthcehck for git-runner 2026-07-06 00:52:20 +03:00
vbevdev a2fc1ed141 deploy dry run regulated via var 2026-07-05 02:02:59 +03:00
vbevdev 3a0e3d419c deploy backup step is now skipable 2026-07-05 01:54:23 +03:00
vbevdev 77ba40f657 fixed password trasfer on sudo backup 2026-07-04 21:00:29 +03:00
vbevdev 5f86776b83 create backup on deploy as sudo to prevent "permission denied" errors 2026-07-04 20:53:53 +03:00
vbevdev bd292c4e84 deploy dir moved from secrets to vars 2026-07-04 20:06:00 +03:00
5 changed files with 290 additions and 11 deletions
+1
View File
@@ -1,3 +1,4 @@
BESZEL_HUB_URL=http://mon.localhost
NEXTCLOUD_DOMAIN=cld.localhost
GITEA_URL=http://git:3000
RUSTDESK_DOMAIN=sup.local
+20 -9
View File
@@ -23,11 +23,12 @@ jobs:
ssh_host: ${{ secrets.SSH_HOST }}
- name: 📦 Create backup of data/ folder
if: ${{ vars.DEPLOY_BACKUP_ENABLED == 'true' }}
env:
SSHPASS: ${{ secrets.SSH_PASSWORD }}
SSH_USERNAME: ${{ secrets.SSH_USERNAME }}
SSH_HOST: ${{ secrets.SSH_HOST }}
DEPLOY_DIRECTORY: ${{ secrets.DEPLOY_DIRECTORY }}
DEPLOY_DIRECTORY: ${{ vars.DEPLOY_DIRECTORY }}
REF_NAME: ${{ env.CLEAN_REF_NAME }}
run: |
sshpass -e ssh -p 22 "$SSH_USERNAME@$SSH_HOST" bash -s << EOT
@@ -42,13 +43,13 @@ jobs:
echo "Creating backup of data/ into \${BACKUP_FILE}..."
if [ -d "data" ]; then
tar -czf "\${BACKUP_FILE}" data
echo "$SSHPASS" | sudo -S tar -czf "\${BACKUP_FILE}" data
echo "✅ Backup created successfully!"
else
echo "⚡️ No data/ folder, backup creation skipped."
fi
find backups/ -type f -name "backup-*.tar.gz" -mtime +7 -delete
echo "$SSHPASS" | sudo -S find backups/ -type f -name "backup-*.tar.gz" -mtime +7 -delete
EOT
- name: 🏗️ Create docker-compose file
@@ -56,7 +57,7 @@ jobs:
SSHPASS: ${{ secrets.SSH_PASSWORD }}
SSH_USERNAME: ${{ secrets.SSH_USERNAME }}
SSH_HOST: ${{ secrets.SSH_HOST }}
DEPLOY_DIRECTORY: ${{ secrets.DEPLOY_DIRECTORY }}
DEPLOY_DIRECTORY: ${{ vars.DEPLOY_DIRECTORY }}
REF_NAME: ${{ env.CLEAN_REF_NAME }}
run: |
sshpass -e ssh -p 22 "$SSH_USERNAME@$SSH_HOST" \
@@ -71,7 +72,7 @@ jobs:
SSHPASS: ${{ secrets.SSH_PASSWORD }}
SSH_USERNAME: ${{ secrets.SSH_USERNAME }}
SSH_HOST: ${{ secrets.SSH_HOST }}
DEPLOY_DIRECTORY: ${{ secrets.DEPLOY_DIRECTORY }}
DEPLOY_DIRECTORY: ${{ vars.DEPLOY_DIRECTORY }}
BESZEL_AGENT_KEY: ${{ secrets.BESZEL_AGENT_KEY }}
BESZEL_AGENT_TOKEN: ${{ secrets.BESZEL_AGENT_TOKEN }}
BESZEL_HUB_URL: ${{ vars.BESZEL_HUB_URL }}
@@ -79,6 +80,7 @@ jobs:
GITEA_URL: ${{ vars.GIT_URL }}
VAULTWARDEN_ADMIN_TOKEN: ${{ secrets.VAULTWARDEN_ADMIN_TOKEN }}
NEXTCLOUD_DOMAIN: ${{ vars.NEXTCLOUD_DOMAIN }}
RUSTDESK_DOMAIN: ${{ vars.RUSTDESK_DOMAIN }}
run: |
sshpass -e ssh -p 22 "$SSH_USERNAME@$SSH_HOST" bash -s << EOT
set -e
@@ -88,6 +90,7 @@ jobs:
BESZEL_HUB_URL=$BESZEL_HUB_URL
NEXTCLOUD_DOMAIN=$NEXTCLOUD_DOMAIN
GITEA_URL=$GITEA_URL
RUSTDESK_DOMAIN=$RUSTDESK_DOMAIN
EOF_ENV
mkdir -p secrets
@@ -117,7 +120,9 @@ jobs:
SSHPASS: ${{ secrets.SSH_PASSWORD }}
SSH_USERNAME: ${{ secrets.SSH_USERNAME }}
SSH_HOST: ${{ secrets.SSH_HOST }}
DEPLOY_DIRECTORY: ${{ secrets.DEPLOY_DIRECTORY }}
DEPLOY_DIRECTORY: ${{ vars.DEPLOY_DIRECTORY }}
DEPLOY_LOG_FILE: /tmp/deploy-${{ env.CLEAN_REF_NAME }}.log
DRY_RUN_ENABLED: ${{ vars.DEPLOY_DRY_RUN_ENABLED }}
REF_NAME: ${{ env.CLEAN_REF_NAME }}
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_DEPLOY_BOT_TOKEN }}
TELEGRAM_CHAT: ${{ secrets.TELEGRAM_DEPLOY_CHAT_ID }}
@@ -128,7 +133,6 @@ jobs:
FAILURE_MESSAGE: |-
❌ <b>Ошибка деплоя!</b>
Релиз: <code>${{ gitea.ref_name }}</code>
DEPLOY_LOG_FILE: /tmp/deploy-${{ env.CLEAN_REF_NAME }}.log
run: |
sshpass -e ssh -p 22 "$SSH_USERNAME@$SSH_HOST" bash -s << EOT
set -e
@@ -136,8 +140,15 @@ jobs:
nohup bash -c '
sleep 5
if [ "${DRY_RUN_ENABLED}" = "true" ]; then
DRY_RUN_FLAG="--dry-run"
else
DRY_RUN_FLAG=""
fi
if docker compose --dry-run -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}" \
@@ -158,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"
+83
View File
@@ -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.
+159
View File
@@ -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-сервисов.
+27 -2
View File
@@ -7,6 +7,9 @@ services:
ports:
- '80:80'
- '443:443'
- '21116:21116/tcp'
- '21116:21116/udp'
- '21117:21117/tcp'
volumes:
- ./data/nginx-proxy-manager/data:/data
- ./data/nginx-proxy-manager/letsencrypt:/etc/letsencrypt
@@ -16,7 +19,7 @@ services:
timeout: 3s
pwd:
image: 'vaultwarden/server:latest'
image: 'vaultwarden/server:1.37.1'
restart: unless-stopped
volumes:
- ./data/vaultwarden:/data
@@ -99,6 +102,28 @@ services:
- /var/run/docker.sock:/var/run/docker.sock
secrets:
- gitea_runner_registration_token
healthcheck:
test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://127.0.0.1:9101/healthz"]
interval: 30s
timeout: 5s
retries: 3
start_period: 10s
sup-hbbs:
image: rustdesk/rustdesk-server:latest
command: hbbs -r ${RUSTDESK_DOMAIN}:21117 -k _
restart: unless-stopped
volumes:
- ./data/rustdesk:/root
depends_on:
- sup-hbbr
sup-hbbr:
image: rustdesk/rustdesk-server:latest
command: hbbr
restart: unless-stopped
volumes:
- ./data/rustdesk:/root
networks:
default:
@@ -113,4 +138,4 @@ secrets:
file: secrets/beszel_agent_token.txt
gitea_runner_registration_token:
file: secrets/gitea_runner_registration_token.txt