Embarrassingly simple GitHub backup tool
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ghbackup
.gitignore
.goreleaser.yml
.travis.yml
license
main.go
readme.md

readme.md

💾 ghbackup

GoDoc Build Status Go Report Card

Backup your GitHub repositories with a simple command-line application written in Go.

The simplest way to keep your repositories save:

  1. Install ghbackup
  2. Get a token from https://github.com/settings/tokens
  3. 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:

go get qvl.io/ghbackup
brew install qvl/tap/ghbackup

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.

systemd runs on most Linux systems and using sleepto it's easy to create a service to schedule a backup.

  • Create a new unit file:
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:

sudo systemctl daemon-reload
sudo systemctl enable --now ghbackup
  • Check if service is running:
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:
0 1 * * * ghbackup -account NAME DIR

For example:

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 and send it like this:

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.

Development

Make sure to use gofmt and create a Pull Request.

Releasing

Push a new Git tag and GoReleaser will automatically create a release.

License

MIT