Обновлен README.md для улучшения документации
- Добавлен статус сборки проекта с помощью GitHub Actions - Включены два варианта быстрого старта: использование готового образа и сборка из исходников - Добавлен раздел о CI/CD с информацией о автоматической сборке и публикации Docker-образов - Уточнены инструкции по настройке и запуску сервиса
This commit is contained in:
41
README.md
41
README.md
@@ -1,5 +1,7 @@
|
||||
# 🗄️ Universal Docker Backup Service
|
||||
|
||||

|
||||
|
||||
Универсальная система автоматического резервного копирования 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
|
||||
|
||||
Reference in New Issue
Block a user