Обновлен README.md для улучшения документации

- Добавлен статус сборки проекта с помощью GitHub Actions
- Включены два варианта быстрого старта: использование готового образа и сборка из исходников
- Добавлен раздел о CI/CD с информацией о автоматической сборке и публикации Docker-образов
- Уточнены инструкции по настройке и запуску сервиса
This commit is contained in:
2025-10-22 09:41:48 +03:00
parent dfd626ce7b
commit c982c4e359
2 changed files with 110 additions and 3 deletions

72
.github/workflows/docker-build.yml vendored Normal file
View File

@@ -0,0 +1,72 @@
name: Build and Push Docker Image
on:
push:
branches:
- main
- master
tags:
- 'v*'
pull_request:
branches:
- main
- master
workflow_dispatch:
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
build-and-push:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to Container Registry
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
type=sha,prefix={{branch}}-
type=raw,value=latest,enable={{is_default_branch}}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
- name: Image digest
run: echo "Image pushed with digest ${{ steps.build-and-push.outputs.digest }}"

View File

@@ -1,5 +1,7 @@
# 🗄️ Universal Docker Backup Service
![Build Status](https://github.com/USERNAME/docker-s3-backup/actions/workflows/docker-build.yml/badge.svg)
Универсальная система автоматического резервного копирования Docker-проектов с загрузкой в S3-совместимое хранилище.
## ✨ Возможности
@@ -13,7 +15,24 @@
## 🚀 Быстрый старт
### 1. Подготовка
### Вариант 1: Использование готового образа (рекомендуется)
Создайте `docker-compose.yaml` в директории вашего проекта:
```yaml
services:
backup:
image: ghcr.io/USERNAME/docker-s3-backup:latest
container_name: project-backup
restart: unless-stopped
environment:
# Ваши настройки (см. ниже)
volumes:
- .:/backup-source:ro
- /var/run/docker.sock:/var/run/docker.sock:ro
```
### Вариант 2: Сборка из исходников
Скопируйте файлы в директорию вашего проекта, который нужно бекапить:
@@ -23,7 +42,7 @@ cd your-project
cp -r backup-system/* .
```
### 2. Настройка
### Настройка
Отредактируйте `docker-compose.yaml` и укажите свои значения переменных окружения:
@@ -41,7 +60,7 @@ environment:
- BACKUP_RETENTION_DAYS=30
```
### 3. Запуск
### Запуск
```bash
docker compose up -d backup
@@ -53,6 +72,8 @@ docker compose up -d backup
docker compose logs -f backup
```
> **Примечание:** Замените `USERNAME` в URL образа на ваш GitHub username после публикации проекта.
## 📋 Переменные окружения
Все параметры подробно описаны в `docker-compose.yaml` с примерами использования.
@@ -219,6 +240,20 @@ docker compose exec backup /scripts/backup.sh
- BACKUP_S3_REGION=us-east-1
```
## 🔄 CI/CD
Проект использует GitHub Actions для автоматической сборки и публикации Docker-образов:
- **Сборка:** При каждом push в main/master
- **Публикация:** Автоматическая публикация в GitHub Container Registry (ghcr.io)
- **Платформы:** Поддержка amd64 и arm64 архитектур
- **Теги:**
- `latest` - последняя версия из main/master
- `v1.0.0` - семантическое версионирование при создании тегов
- `main-sha` - образы с хешем коммита
Готовые образы доступны по адресу: `ghcr.io/USERNAME/docker-s3-backup`
## 📝 Лицензия
MIT