Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/canardconfit/backup-git
Automated Git repository backup solution with Alpine Linux and Docker.
https://github.com/canardconfit/backup-git
backup backup-script docker docker-compose git
Last synced: 29 days ago
JSON representation
Automated Git repository backup solution with Alpine Linux and Docker.
- Host: GitHub
- URL: https://github.com/canardconfit/backup-git
- Owner: CanardConfit
- License: mpl-2.0
- Created: 2024-03-01T10:09:21.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-10T00:25:40.000Z (10 months ago)
- Last Synced: 2024-04-20T00:03:56.413Z (9 months ago)
- Topics: backup, backup-script, docker, docker-compose, git
- Language: Shell
- Homepage: https://hub.docker.com/repository/docker/canardconfit/backup-git/
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Git Repository Backup Solution
This solution provides an automated way to back up a Git repository hosted on an Alpine Linux container. The setup involves a Docker container configured with cron jobs to perform daily backups of the specified Git repository. This README outlines the setup process, how to configure your environment, and how to use the backup solution.
## Features
- **Scheduled Backups**: Leverages `dcron` to schedule daily backups at midnight by default (ENV variable `CRON_SCHEDULE`).
- **Environment Customization**: Allows configuration of source directory, commit message template, Git remote URL, and SSH private key through environment variables.
- **SSH Key Management**: Incorporates SSH setup for Git operations to securely connect to the remote repository.
- **Timezone Management**: Timezone configuration within the container.
## Prerequisites
- Docker and Docker Compose installed on your host machine.
- Base64 encoded SSH private key for secure Git operations.
- Access to the Git remote repository configured with the provided SSH key.
## Docker Compose Configuration
The `docker-compose.yml` file facilitates the deployment of the backup solution and, for my personal use, the https://github.com/CanardConfit/livesync-bridge service. Here's an example configuration:
```yaml
services:
livesync-bridge:
image: canardconfit/livesync-bridge
environment:
TZ: Europe/Zurich
volumes:
- /your/local/path:/livesync-bridge/dat/
- obsidian-volume:/livesync-bridge/obsidian/
git:
image: canardconfit/backup-git
depends_on:
- livesync-bridge
volumes:
- obsidian-volume:/obsidian/
- git-volume:/git-repo/
environment:
TZ: Europe/Zurich
CRON_SCHEDULE: "0 0 * * *"
SOURCE_FOLDER_PATH: "/obsidian/"
COMMIT_MESSAGE_TEMPLATE: "Backup on CURRENT_DATE" # CURRENT_DATE is a placeholder
GIT_REMOTE_URL: ""
SSH_PRIVATE_KEY: ""
volumes:
obsidian-volume:
git-volume:
```
## Running the Backup Solution
To run the backup solution, execute:
```bash
docker compose up -d
```
This command starts the containers defined in `docker-compose.yml`, running the backup operations as configured.
## Monitoring and Logs
To monitor backup operations, you can check the cron logs within the container:
```bash
docker logs
```
## Contributions
We warmly welcome contributions to this project!
## License
This project is released under MPL-2.0.
The MPL-2.0 license allows the mixing of the covered code with other code under different licenses, provided that the MPL-2.0-covered code remains governed by the MPL-2.0 terms.
For more information about the license, please refer to the [LICENSE](LICENSE) file in the root of this project or visit [Mozilla's official MPL 2.0 page](http://mozilla.org/MPL/2.0/).