Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrewslotin/doppelganger
A tool to mirror GitHub repositories.
https://github.com/andrewslotin/doppelganger
backup git github-mirror hacktoberfest mirror
Last synced: 15 days ago
JSON representation
A tool to mirror GitHub repositories.
- Host: GitHub
- URL: https://github.com/andrewslotin/doppelganger
- Owner: andrewslotin
- License: mpl-2.0
- Created: 2015-12-11T17:41:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T11:39:17.000Z (7 months ago)
- Last Synced: 2024-06-19T06:00:00.300Z (5 months ago)
- Topics: backup, git, github-mirror, hacktoberfest, mirror
- Language: Go
- Homepage:
- Size: 2.89 MB
- Stars: 14
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
A tool to create and maintain mirrors of GitHub repositories. Once the repostiory is mirrored a
webhook is set up, so next time you push to GitHub `master` mirror will be updated. You may also trigger an update
manually by clicking "Synchronize repository".
[](https://travis-ci.org/andrewslotin/doppelganger)
[](https://goreportcard.com/report/github.com/andrewslotin/doppelganger)
Why Would I Need It?
--------------------
Well, if you ask this question then most likely you won't. But next time some Chinese website
[decides to host their assets on GitHub](http://arstechnica.com/security/2015/03/massive-denial-of-service-attack-on-github-tied-to-chinese-government/) you know you've been warned.
Installation
------------
Create new [personal access token](http://github.com/settings/tokens) with following permissions:
* `public_repo`
* `write:repo_hook`
Make sure you have `git` installed.
Download the [latest release](https://github.com/andrewslotin/doppelganger/releases), extract it and then run:
```bash
DOPPELGANGER_GITHUB_TOKEN= ./doppelganger
```
This will run a server listening on `0.0.0.0:8081` and all mirrored repositories will go to `./mirror`.
Run `./doppelganger --help` to learn how to override these defaults.
### Build From Source
```bash
# Download and compile
go get github.com/andrewslotin/doppelganger
# Current working dir should have templates/ and assets/ folders
cd $GOPATH/src/github.com/andrewslotin/doppelganger
# Run it
DOPPELGANGER_GITHUB_TOKEN= $GOPATH/bin/doppelganger
```
### Docker
```bash
docker pull andrewslotin/doppelganger
docker run -d --name doppelganger -e DOPPELGANGER_GITHUB_TOKEN= -v /home/git:/var/mirrors -p 8081:8081 andrewslotin/doppelganger
```
See [Docker Hub Page](https://hub.docker.com/r/andrewslotin/doppelganger/) for details.
Usage
-----
Mirrors can be used just like any other git remote. You can even push your changes there directly, but note that they will be discarded next time someone pushes
to GitHub `master`.
Following exaples assume you have `git` user set up on your mirror server with `HOME` set to Doppelganger mirror directory.
Set up a new local copy of `github.com/example/project` from mirror:
```bash
git clone git@:example/project
```
Use mirror as a second remote in already existing repository:
```bash
git add remote mirror git@:example/project
# Make your local master using mirror as an upstream:
git branch --unset-upstream master
git branch --set-upstream master mirror/master
git reset master mirror/master
# Switch back to GitHub
git branch --unset-upstream master
git branch --set-upstream master origin/master
```
Mirroring Private Repositories
------------------------------
To mirror private repositories your personal access token should have `repo` permission.
Doppelganger uses `git+ssh` protocol to clone private repositories, which requires an SSH key to be present in the system.
While attempting to clone a private repository Doppelganger will try to use an existing key stored in `~/.ssh`. If there
is no key it will attempt generate a new 2048-bit RSA key pair and offer to add the public key to the list of [your GitHub SSH keys](https://github.com/settings/keys).