diff --git a/docs/management.md b/docs/management.md index 2c9801c0dec96fe06ac41314899b31e609ef20d2..b2a7eeda8b77fb743a13f16a7a81f0fe9122f7ec 100644 --- a/docs/management.md +++ b/docs/management.md @@ -4,7 +4,9 @@ A short overview of managing mirrored repositories. This assumes you have alrea *Note: any repository type other than git may or may not update the CLI with status text. For extremely large alternate repository types (e.g. Bazaar) it can take a long time to clone with little or no output to the CLI until the initial BZR clone has finished.* -### Create a mirror +## Create a mirror + +### git Create a git repository mirror. @@ -12,13 +14,19 @@ Create a git repository mirror. cd gitlab-mirrors ./add_mirror.sh --git --project-name github-gitlab-mirrors --mirror https://github.com/sag47/gitlab-mirrors.git +### svn + +The subversion support comes from [`git-svn(1)`](https://www.kernel.org/pub/software/scm/git/docs/git-svn.html). + Create an SVN repository mirror. su - gitmirror cd gitlab-mirrors ./add_mirror.sh --svn --project-name someproject --mirror svn+ssh://user@svn.example.com/srv/repos/someproject --authors-file ./authors.txt -The `--authors-file` option is an optional argument. See `add_mirror.sh -h` for details. +The `--authors-file` option is an optional argument. It serves the same purpose as the `git-svn --authors-file` option. It is an authors file for mapping SVN users to git users. See the `git-svn(1)` man page for more details. Notice in [`config.sh`](../config.sh.SAMPLE) there's an option `git_svn_additional_options`. This option affects `add_mirror.sh` and the creation of a mirror only. It doesn't affect the synchronization of the svn repository. See the `git-svn(1)` man page under `init` COMMAND options. + +### Bazaar Create a BZR repository mirror. @@ -26,30 +34,30 @@ Create a BZR repository mirror. cd gitlab-mirrors ./add_mirror.sh --bzr --project-name bzr-ubuntu-hello --mirror lp:ubuntu/hello -### List all known mirrors +## List all known mirrors su - gitmirror cd gitlab-mirrors ./ls-mirrors.sh -### Delete a mirror +## Delete a mirror su - gitmirror cd gitlab-mirrors ./delete_mirror.sh --delete someproject -### Update a mirror +## Update a mirror su - gitmirror cd gitlab-mirrors ./update_mirror.sh project_name -### Update all known mirrors +## Update all known mirrors su - gitmirror cd gitlab-mirrors ./git-mirrors.sh -Updating all known mirrors is also meant to be used with `crontab`. +Updating all known mirrors is also meant to be used with a cron job via `crontab`. See `man 5 crontab`. @hourly /home/gitmirror/gitlab-mirrors/git-mirrors.sh