IMPORTANT: This is a FORK of the original gitbackup
Original version:
- Initial Backup:
git clone <repo> - Update:
git pull
This version:
- Initial Backup:
git clone --mirror <repo> - Update: `git remote update --prune
The original gitbackup is a pretty great tool, and very well documented, but it doesn't actually do what I wanted. I wanted a FULL backup of my Gitlab, including tags and remote branches, so that any work that got pushed to Gitlab would end up in my backup, even if it were never merged to master. The original gitbackup does a 'normal' git clone and then 'updates' by calling 'git pull' on the master branch. This is fine for some use cases, but not what I was looking for..
This version creates a bare git mirror repository. In order to use your gackup, you need to clone from the backup into a working git repo.
I'll probably eventually packge this into a PR for the original, and make it conditional on a --full-backup option or something, but right now I just need a thing that works.
#Code Quality
#Linux/Mac OS X
gitbackup is a tool to backup your git repositories from GitHub (including GitHub enterprise) or
GitLab (including custom GitLab installations).
gitbackup only creates a backup of the repository and does not currently support issues,
pull requests or other data associated with a git repository. This may or may not be in the future
scope of this tool.
If you are following along my Linux Journal article (published in 2017), please obtain the version of the source tagged with lj-0.1.
Binary releases are available from the Releases page. Please download the binary corresponding to your OS
and architecture and copy the binary somewhere in your $PATH. It is recommended to rename the binary to gitbackup or gitbackup.exe (on Windows).
gitbackup requires a GitHub API access token for
backing up GitHub repositories and GitLab personal access token
for GitLab. You can supply the token to gitbackup using GITHUB_TOKEN and GITLAB_TOKEN environment variables respectively.
repo: Reading repositories, including private repositoriesuser - read:user: Reading the authenticated user details. This is only needed for retrieving your username when cloning via HTTPS and retrieving private repositories.
api: Grants complete read/write access to the API, including all groups and projects. For some reason,read_userandread_repositoryis not sufficient.
When you provide the tokens via environment variables, they remain accessible in your shell history
and via the processes' environment for the lifetime of the process. By default, SSH authentication
is used to clone your repositories. If use-https-clone is specified, private repositories
are cloned via https basic auth and the token provided will be stored in the repositories'
.git/config.
Typing -help will display the command line options that gitbackup recognizes:
$ gitbackup -help
Usage of ./bin/gitbackup:
-backupdir string
Backup directory
-githost.url string
DNS of the custom Git host
-github.repoType string
Repo types to backup (all, owner, member) (default "all")
-gitlab.projectMembershipType string
Project type to clone (all, owner, member) (default "all")
-gitlab.projectVisibility string
Visibility level of Projects to clone (internal, public, private) (default "internal")
-ignore-private
Ignore private repositories/projects
-service string
Git Hosted Service Name (github/gitlab)
-use-https-clone
Use HTTPS for cloning instead of SSH
To backup all your GitHub repositories to the default backup directory ($HOME/.gitbackup/):
$ GITHUB_TOKEN=secret$token gitbackup -service github
To backup only the GitHub repositories which you are the "owner" of:
$ GITHUB_TOKEN=secret$token gitbackup -service github -github.repoType owner
To backup only the GitHub repositories which you are the "member" of:
$ GITHUB_TOKEN=secret$token gitbackup -service github -github.repoType member
To backup all projects you either own or are a member of which have their visibility set to
"internal" on https://gitlab.com to the default backup directory ($HOME/.gitbackup/):
$ GITLAB_TOKEN=secret$token gitbackup -service gitlab
To backup only the GitLab projects (either you are an owner or member of) which are "public"
$ GITLAB_TOKEN=secret$token gitbackup -service gitlab -gitlab.projectVisibility public
To backup only the private repositories (either you are an owner or member of):
$ GITLAB_TOKEN=secret$token gitbackup -service gitlab -gitlab.projectVisibility private
To backup public repositories which you are an owner of:
$ GITLAB_TOKEN=secret$token gitbackup \
-service gitlab \
-gitlab.projectVisibility public \
-gitlab.projectMembershipType owner
To backup public repositories which you are an member of:
$ GITLAB_TOKEN=secret$token gitbackup \
-service gitlab \
-gitlab.projectVisibility public \
-gitlab.projectMembershipType member
To specify a custom GitHub enterprise or GitLab location, specify the service as well as the
the githost.url flag, like so
$ GITLAB_TOKEN=secret$token gitbackup -service gitlab -githost.url https://git.yourhost.com
To specify a custom backup directory, we can use the backupdir flag:
$ GITHUB_TOKEN=secret$token gitbackup -service github -backupdir /data/
This will create a github.com directory in /data and backup all your repositories there instead.
Similarly, it will create a gitlab.com directory, if you are backing up repositories from gitlab.
If you have specified a Git Host URL, it will create a directory structure data/host-url/.
If you have Golang 1.12.x+ installed, you can clone the repository and:
$ go build
The built binary will be gitbackup.