Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/samrocketman/gitlab-mirrors

A set of scripts adding the ability of managing remote mirrors to GitLab.
https://github.com/samrocketman/gitlab-mirrors

backups github-backups gitlab gitlab-mirror mirrored-repositories mirroring replication

Last synced: 4 days ago
JSON representation

A set of scripts adding the ability of managing remote mirrors to GitLab.

Lists

README 

        
# gitlab-mirrors



The [gitlab-mirrors](https://github.com/samrocketman/gitlab-mirrors) project is

designed to fill in a feature which is currently [missing from

GitLab][mirror-missing]: the ability to mirror remote repositories.

gitlab-mirrors creates read only copies of remote repositories in gitlab.  It

provides a CLI management interface for managing the mirrored repositories (e.g.

add, delete, update) so that an admin may regularly update all mirrors using

`crontab`.  It operates by interacting with the [GitLab API][gitlab-api] using

[python-gitlab][python-gitlab].



## Features



* Mirror different types of source repositories:  Bazaar, Git, Mercurial,

  Subversion.  Mirror all into git.

* GitLab mirror adding.

  * When adding a mirror if the project doesn't exist in GitLab it will be

    auto-created.

  * Set project creation defaults (e.g. issues enabled, wiki enabled, etc.)

  * Delete mirrors both local and remote.

* non-GitLab mirror adding.

  * Manually specify the remote and don't attempt API communication to GitLab

    nor attempt to create the remote project.

  * Delete mirrors locally only without communicating to GitLab to delete the

    remote project.

  * This feature is for mirroring git repositories generically which can be used

    by any git hosting server or service.  This feature was originally added

    with mirroring GitLab wikis in mind but allows gitlab-mirrors to be more

    versatile.

  * no-remote mirroring where you don't need a remote git repository at all.

    Just mirror the repositories to local disk.

* Update a single mirror.

* Update all known mirrors.

* List all known mirrors.



---

# Three easy steps



1. [Set up prerequisites](docs/prerequisites.md)

2. [Install gitlab-mirrors](docs/installation.md)

3. [Manage your mirrors](docs/management.md)



*Note: if you are upgrading then see `docs/upgrade` for notes on upgrading.*



---

# Other helpful implementations



* [Puppet module][gm-puppet] for installing and configuring gitlab-mirrors.

* [Docker container][gm-docker] for mirroring repositories.



---

# Get help



There are a couple ways you can try to get help.  You can [file an

issue][issues].  You can also join the `#gitlab` IRC channel at freenode.net and

direct your questions to user `sag47`.



## IRC Etiquette



* I generally stay logged in to freenode so be sure to mention my handle when

  you're asking questions so that I see it in the `#gitlab` channel.

* If I don't answer right away then just hang out in the channel.  I will

  eventually write back to you as it just means I'm away from my keyboard,

  working on something else, or in a different timezone than you.

* You should treat IRC as what it is: asynchronous chat.  Sure the messages can

  be instant but in most channels people are in different time zones.  At times

  chat replies can be in excess of 24hrs.



---

# License



Created by Sam Gleske under [MIT License](LICENSE).



## Contributors



* Docs #1 [lmakarov](https://github.com/lmakarov)

* Bzr support #6 [Agustín Cruz Lozano](https://github.com/agb80)

* SVN update tags #13 [Nikolaus Krismer](https://github.com/nikolauskrismer)

* Docs #26 [Glen Mailer](https://github.com/glenjamin)

* Docs #54  [Martijn Vermaat](https://github.com/martijnvermaat)

* Better logging #57 [Loic Dachary](https://github.com/dachary)

* Fixed project transfer bug #78 [Corey Osman](https://github.com/logicminds)

* Added support for GitLab API v4 #100 [Romke van Dijk](https://github.com/zyronix)



[gitlab-api]: http://api.gitlab.org/

[gm-docker]: https://github.com/Klowner/docker-gitlab-mirrors

[gm-puppet]: https://github.com/logicminds/gitlab_mirrors

[issues]: https://github.com/samrocketman/gitlab-mirrors/issues

[mirror-missing]: http://feedback.gitlab.com/forums/176466-general/suggestions/4286666-mirror-git-svn-into-repo-

[python-gitlab]: https://github.com/python-gitlab/python-gitlab