diff --git a/doc/workflow/repository_mirroring.md b/doc/workflow/repository_mirroring.md index 7d417024ac3688c8a6fea2038ee36bd7a6be124f..0629555e9f9c60c6df578634ac551b86ad7319d2 100644 --- a/doc/workflow/repository_mirroring.md +++ b/doc/workflow/repository_mirroring.md @@ -1,5 +1,29 @@ + # Repository Mirroring +## Overview + +It's a way to mirror repositories from external sources. It's going to mirror all +the branches, tags, and commits that you have in your project within another +Git management service. + +It's very useful when, for some reason, you cannot simply remove a project +from another source. + +Your mirror at GitLab will be updated automatically once an hour. You can manually +update it whenever you need. + +## Use-cases + +- You migrated to GitLab but still needs to keep you project in another source. +You simple set it up to mirror to GitLab and all the essential history of +commits, tags and branches will be reproduced in your GitLab EE instance. +- You have old projects in another source that you don't use actively anymore. +You create a mirror to your active GitLab EE instance to be able to be aware of +any eventual changes in your project. + +## Description + You can set up a project to automatically have its branches, tags, and commits updated from an upstream repository. This is useful when a repository you're interested in is located on a different server, and you want to be able to browse its content and its activity using the familiar GitLab interface.