https://github.com/bean5/docker.borg
Borg wrapped in a docker-compose for backup calls without incurring local dependencies
https://github.com/bean5/docker.borg
Last synced: 5 months ago
JSON representation
Borg wrapped in a docker-compose for backup calls without incurring local dependencies
- Host: GitHub
- URL: https://github.com/bean5/docker.borg
- Owner: bean5
- Created: 2024-09-20T22:31:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-11T20:59:30.000Z (10 months ago)
- Last Synced: 2025-09-11T23:04:54.476Z (10 months ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backup via containerized borg
This project uses borg to build backup archives that are compressed, and deduplicated.
It uses docker for low-dependency standup. Borg automatically creates some caching files. The docker compose config files here are written to make use of those caches by storing them in docker volumes. They are not required and you can remove them. However, subsequent backups will lose out on potential speed-ups. If you do not use a cache, you will also get alerts for "unknown unencrypted repositories"; encrypted ones for which you know the key are assumed to be trusted. This is expected functionality.
The docker compose file has 5 targets:
- `init` - Initializes a backup "repo". Only needs to be run one time.
- `backup` - Builds an backup archive. Can run whenever you want to run a backup.
- `list` - For perusing your backup repository. This is read-only.
- `restore` - This is the one you will use when you need to restore a file.
- `crud` - This can do anything and is helpful for debug and general purposes.
## Tutorial
This tutorial assumes you have a dropbox folder that you want to back up to another location.
### Configuration
- Install docker
- Open `compose.yml`
- Replace `/pathToMyFolderToBackup` with the full path to a folder that you want to back up
- Replace `/pathToMyBackupFolder` with the full path to a folder that you want to back up
- Proceed with the next main steps
### Initialize a backup
```bash
docker compose build && docker compose run init
```
### Run a backup
```sh
docker compose build && docker compose run backup
```
### List archives
```sh
docker compose build && docker compose run list
```
### Prepare for a restore
```sh
docker compose build && docker compose run restore
```
## See also
-
-