Windows software to backup all repositories in your GitHub account
Switch branches/tags
Nothing to show
Clone or download
jesperhoy Merge pull request #5 from vcastroi/master
Encodes username and password for GitHubUrl function
Latest commit 47afb8b Oct 11, 2018

README.md

GitHub Backup for Windows

A tool to automatically create and update backups of all repositories under your GitHub account onto a Windows computer.

This tool can be scheduled to run using the Windows Task Scheduler (for example once a day).

It can send you a status notification via e-mail for each run (optionally only for failures).

It can optionally create a log file to disk for each run.

Backups are real mirror / bare repositories. This means that they have no working directory, but if needed, you can make a clone (with a working directory) directly from a backup repository by specifying the backup repository directory as the source path.

You can filter which repositories to backup by privacy (public/private), affiliation (owner, contributor, organization-member), locked or not, fork or not.

Why this tool exists

Please see this blog post.

How it works

When run, the tool first fetches a list of your GitHub repositories (using the GitHub GraphQL API). Then it makes a local mirror clone of each of these. If a local mirror clone already exists (from prior runs), it updates this with the latest changes from GitHub.

The tool consists of two Windows executable files "GitHubBackup.exe" and "GitHubBackupCfg.exe":

  • "GitHubBackup.exe" is a command line tool which does the actual backup operations as described above.
  • "GitHubBackupCfg.exe" is a Windows GUI program used to create a configuration file: screenshot

Backup repositories are stored in the "repositories" directory below the directory where "GitHubBackup.exe" is located.

The backup repositories are named "<GitHubLogin>_<RepositoryName>.git".

Logs are stored in the "logs" directory below the directory where "GitHubBackup.exe" is located.

Setup

First make sure that "Git for Windows" ( https://git-scm.com/download/win ) and .NET Framework 4.6 are installed / enabled on the computer.

Next create a directory that will be the root of the backups and download ( https://github.com/jesperhoy/GitHubBackup/releases/latest ) and unzip the tool .exe files there.

Run "GitHubBackupCfg.exe" to make a configuration file. This generates a "config.json" file stored in the same directory as the .exe files.

Run "GitHubBackup.exe" to make the initial backup and make sure everything is working correctly.

Use Windows Task Scheduler to schedule running "GitHubBackup.exe" on a regular basis.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.