Merge branch 'stable-3.11' * stable-3.11: FetchOne: consider order of create/delete events when replicating deletions Consume only relevant stream events Use stream events to delete repositories Change-Id: Iaf74d8b0011de854da6b92ab95f2af3f72a93aaa
diff --git a/src/main/resources/Documentation/about.md b/README.md similarity index 65% rename from src/main/resources/Documentation/about.md rename to README.md index 247ff23..c7ee16a 100644 --- a/src/main/resources/Documentation/about.md +++ b/README.md
@@ -1,25 +1,32 @@ +# Gerrit pull-replication plugin + This plugin can automatically mirror repositories from other systems. Overview -------- Typically replication should be done over SSH, with a passwordless -public/private key pair. On a trusted network it is also possible to +public/private key pair. On a trusted network it is also possible to use replication over the insecure (but much faster due to no authentication overhead or encryption) git:// protocol, by enabling the `upload-pack` service on the receiving system, but this -configuration is not recommended. It is also possible to specify a -local path as replication source. This makes e.g. sense if a network +configuration is not recommended. It is also possible to specify a +local path as replication source. This makes sense if a network share is mounted to which the repositories should be replicated from. -Access ------- +## Access + To be allowed to trigger pull replication a user must be a member of a group that is granted the 'Pull Replication' capability (provided by this plugin) or the 'Administrate Server' capability. -Change Indexing --------- +## Change Indexing + Changes will be automatically indexed upon replication. + + +For more information please refer to the [docs](src/main/resources/Documentation) + +