Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qvl/ghbackup
Embarrassingly simple GitHub backup tool
https://github.com/qvl/ghbackup
backup cli github golang
Last synced: about 1 month ago
JSON representation
Embarrassingly simple GitHub backup tool
- Host: GitHub
- URL: https://github.com/qvl/ghbackup
- Owner: qvl
- License: mit
- Archived: true
- Created: 2016-08-02T09:43:06.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T13:22:41.000Z (over 2 years ago)
- Last Synced: 2024-06-21T10:17:03.569Z (3 months ago)
- Topics: backup, cli, github, golang
- Language: Go
- Homepage: https://qvl.io/ghbackup
- Size: 86.9 KB
- Stars: 162
- Watchers: 6
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# :floppy_disk: ghbackup
[](https://godoc.org/qvl.io/ghbackup)
[](https://travis-ci.org/qvl/ghbackup)
[](https://goreportcard.com/report/qvl.io/ghbackup)
Backup your GitHub repositories with a simple command-line application written in Go.
The simplest way to keep your repositories save:
1. [Install](#install) `ghbackup`
1. Get a token from https://github.com/settings/tokens
2. `ghbackup -secret token /path/to/backup/dir`
This will backup all repositories you have access to.
-----------------------------------
Embarrassing simple GitHub backup tool
Usage: ghbackup [flags] directory
directory path to save the repositories to
At least one of -account or -secret must be specified.
Flags:
-account string
GitHub user or organization name to get repositories from.
If not specified, all repositories the authenticated user has access to
will be loaded.
-secret string
Authentication secret for GitHub API.
Can use the users password or a personal access token (https://github.c
om/settings/tokens).
Authentication increases rate limiting (https://developer.github.com/v3
/#rate-limiting) and enables backup of private repositories.
-silent
Suppress all output
-version
Print binary version
For more visit https://qvl.io/ghbackup.
## Install
- Note that `ghbackup` uses `git` under the hood. Please make sure it is installed on your system.
- With [Go](https://golang.org/):
```
go get qvl.io/ghbackup
```
- With [Homebrew](http://brew.sh/):
```
brew install qvl/tap/ghbackup
```
- Download binary: https://github.com/qvl/ghbackup/releases
## Automation
Mostly, we like to setup backups to run automatically in an interval.
Let's setup `ghbackup` on a Linux server and make it run daily at 1am. This works similar on other platforms.
There are different tools to do this:
### systemd and sleepto
*Also see [this tutorial](https://jorin.me/automating-github-backup-with-ghbackup/).*
[systemd](https://freedesktop.org/wiki/Software/systemd/) runs on most Linux systems and using [sleepto](https://qvl.io/sleepto) it's easy to create a service to schedule a backup.
- Create a new unit file:
``` sh
sudo touch /etc/systemd/system/ghbackup.service && sudo chmod 644 $_
```
- Edit file:
```
[Unit]
Description=GitHub backup
After=network.target
[Service]
User=jorin
ExecStart=/PATH/TO/sleepto -hour 1 /PATH/TO/ghbackup -account qvl /home/USER/github
Restart=always
[Install]
WantedBy=multi-user.target
```
- Replace the paths with your options.
- Start service and enable it on boot:
``` sh
sudo systemctl daemon-reload
sudo systemctl enable --now ghbackup
```
- Check if service is running:
``` sh
systemctl status ghbackup
```
### Cron
Cron is a job scheduler that already runs on most Unix systems.
- Run `crontab -e`
- Add a new line and replace `NAME` and `DIR` with your options:
``` sh
0 1 * * * ghbackup -account NAME DIR
```
For example:
``` sh
0 1 * * * ghbackup -account qvl /home/qvl/backup-qvl
```
### Sending statistics
The last line of the output contains a summary.
You can use this to collect statistics about your backups.
An easy way would be to use a [Slack hook](https://api.slack.com/incoming-webhooks) and send it like this:
```sh
ghbackup -secret $GITHUB_TOKEN $DIR \
| tail -n1 \
| xargs -I%% curl -s -X POST --data-urlencode 'payload={"text": "%%"}' $SLACK_HOOK
```
## What happens?
Get all repositories of a GitHub account.
Save them to a folder.
Update already cloned repositories.
Best served as a scheduled job to keep your backups up to date!
## Limits
`ghbackup` is about repositories.
There are other solutions if you like to backup issues and wikis.
## Use as Go package
From another Go program you can directly use the `ghbackup` sub-package.
Have a look at the [GoDoc](https://godoc.org/qvl.io/ghbackup/ghbackup).
## Development
Make sure to use `gofmt` and create a [Pull Request](https://github.com/qvl/ghbackup/pulls).
### Releasing
Push a new Git tag and [GoReleaser](https://github.com/goreleaser/releaser) will automatically create a release.
## License
[MIT](./license)