https://github.com/maxakuru/git-backup

Sync files/folders to git repositories, schedule with Docker image
https://github.com/maxakuru/git-backup

automation backup data-storage docker git github raspberry-pi sync

Last synced: about 1 month ago
JSON representation

Sync files/folders to git repositories, schedule with Docker image

• Host: GitHub
• URL: https://github.com/maxakuru/git-backup
• Owner: maxakuru
• Created: 2022-07-25T05:13:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T15:33:19.000Z (about 2 years ago)
• Last Synced: 2023-03-05T11:38:08.015Z (almost 2 years ago)
• Topics: automation, backup, data-storage, docker, git, github, raspberry-pi, sync
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# git-backup

[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/maxakuru/git-backup?label=Docker%20image)](https://hub.docker.com/r/maxakuru/git-backup) [![Publish](https://github.com/maxakuru/git-backup/actions/workflows/publish.yml/badge.svg)](https://github.com/maxakuru/git-backup/actions/workflows/publish.yml) [![Test](https://github.com/maxakuru/git-backup/actions/workflows/test.yml/badge.svg)](https://github.com/maxakuru/git-backup/actions/workflows/test.yml)

```

🚨 Git is not designed to serve as a backup tool.

```

..but this does it anyway. Backup files/folders to a git repo. Run on a cron schedule or repeated loop with delay. Archive files/folders and set specific destinations in remote repository. Use Git LFS or chunking for oversized files.

## Install

### With Docker

```sh

docker pull maxakuru/git-backup

```

```sh

docker run -it --rm \

    -v $PWD/config:/backup/config \

    -v $PWD/repos:/backup/repos \

    -v $PWD/secrets:/backup/secrets \

    -e REPO_NAME= \

    -e REPO_OWNER= \

    -e GIT_TOKEN= \

    -e PATHS=local/path/one:remote/path/one,local/path/two:remote/path/two \

    -e LOOP= \

    -e LOOP_INTERVAL= \

    -e LOOP_SCHEDULE= \

    -e COMPRESS= \

    -e SAVE_CONFIG= \

    -e SAVE_SECRETS= \

    -e GIT_ADD= \

    -e GIT_COMMIT= \

    -e GIT_PUSH= \

    -e GIT_MESSAGE= \

    -e GIT_EMAIL= \

    -e GIT_NAME= \

    -e LOG_LEVEL=<0|1|2|3|4|5> \

    maxakuru/git-backup

```

## With Docker Compose

```yaml

# docker-compose.yaml

backup:

    container_name: backup

    image: maxakuru/git-backup:latest

    restart: always

    environment:

        - REPO_NAME=

        - REPO_OWNER=

        - GIT_TOKEN=

        # - ... see above

```

## Dev

### Run with local changes

```sh

docker run -it --rm -v $PWD/volume:/backup/config \

    -v $PWD/git_backup:/backup/git_backup \

    -e REPO_NAME= \

    -e REPO_OWNER= \

    -e GIT_TOKEN= \

    -e PATHS= \

    maxakuru/git-backup:dev

```

### Test

```sh

echo "MY_GITHUB_TOKEN= >> .env"

./test/functional/test.sh

```

### Build

```sh

docker build -t maxakuru/git-backup:dev .

```

### Run

```sh

docker run -it --rm -v $PWD/volume:/backup/config \

    -e REPO_NAME= \

    -e REPO_OWNER= \

    -e GIT_TOKEN= \

    -e PATHS= \

    maxakuru/git-backup:dev

```

### Open shell

```sh

docker run -it --rm -e="CLI=true" -v $PWD/volume:/backup/config maxakuru/git-backup:dev /bin/bash

```