mirror of
https://github.com/morten-olsen/github-backup.git
synced 2026-02-08 01:36:24 +01:00
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# Simple GitHub Backup
|
|
|
|
A simple GitHub backup image, which will fetch a mirror backup of all repos the user is associated with from GitHub
|
|
|
|
## Usage
|
|
```
|
|
docker run -it --rm \
|
|
-e GITHUB_TOKEN="$GH_TOKEN" \
|
|
-v "$PWD/backup:/backup" \
|
|
--cap-drop=all \
|
|
--user "$UID:$GID" \
|
|
ghcr.io/morten-olsen/github-backup run
|
|
```
|
|
_Note: `--user` is not required, but recommended instead of running as root. Remember to give the user write access to the backup directory_
|
|
|
|
You can also limit which repositories to back up using the environment variables `INCLUDE` and `EXCLUDE`, which supports a list or repos separated by `,` and with `*` as wildcard
|
|
|
|
```
|
|
-e INCLUDE="morten-olsen/*,morten-olsen-env/dotfiles" -e EXCLUDE="morten-olsen/something,*/test"
|
|
```
|
|
|
|
## Backup structure
|
|
```
|
|
|-{user1}
|
|
| |-{repo1}
|
|
| | |-info.json
|
|
| | |-git
|
|
| | | |-...
|
|
| |-{repo2}
|
|
| | |-info.json
|
|
| | |-git
|
|
| | | |-...
|
|
|-{user2}
|
|
| |-{repo1}
|
|
| | |-info.json
|
|
| | |-git
|
|
| | | |-...
|
|
```
|
|
|
|
## Scheduled
|
|
|
|
If the container is started without a command it will run in scheduled mode. It will run every Sunday at 3 am. This can be overridden using `-e SCHEDULE="0 0 4 * * *"` (Runs at 4 am every day) using the cron time format
|