diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml new file mode 100644 index 0000000..0bdfa12 --- /dev/null +++ b/.github/workflows/docker-build.yml @@ -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 }}" + diff --git a/README.md b/README.md index 7b09f35..19beb53 100644 --- a/README.md +++ b/README.md @@ -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