Initialize sync-index plugin with first version
Sync-index plugin keeps the secondary index synchronized among two
Gerrit instances that share the same git repositories and Gerrit
database.
Using a new extension point in Gerrit core [1], this plugin is notified
every time a change has been indexed in or removed from the secondary
index. Then it propagates that information to the configured target
Gerrit instance. The sync-index plugin installed in the target instance
updates the corresponding secondary index accordingly.
[1] https://gerrit-review.googlesource.com/#/c/72607/
Change-Id: Id5c089cfe3263f23dd56880e47d609180aeb3edc
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
new file mode 100644
index 0000000..48b9e94
--- /dev/null
+++ b/src/main/resources/Documentation/config.md
@@ -0,0 +1,51 @@
+@PLUGIN@ Configuration
+=========================
+
+In order for the synchronization to work, the @PLUGIN@ plugin must be installed
+in both instances and the following fields should be specified in the
+corresponding Gerrit configuration file:
+
+File 'gerrit.config'
+--------------------
+
+[plugin "@PLUGIN@"]
+: url = target_instance_url
+: user = username
+: password = password
+
+plugin.@PLUGIN@.url
+: Specify the URL for the secondary (target) instance.
+
+plugin.@PLUGIN@.user
+: Username to connect to the secondary (target) instance.
+
+plugin.@PLUGIN@.password
+: Password to connect to the secondary (target) instance. This value can
+ also be defined in secure.config.
+
+@PLUGIN@ plugin uses REST API calls to index changes in the target instance. It
+is possible to customize the parameters of the underlying http client doing these
+calls by specifying the following fields:
+
+@PLUGIN@.connectionTimeout
+: Maximum interval of time in milliseconds the plugin waits for a connection
+ to the target instance. When not specified, the default value is set to 5000ms.
+
+@PLUGIN@.socketTimeout
+: Maximum interval of time in milliseconds the plugin waits for a response from the
+ target instance once the connection has been established. When not specified,
+ the default value is set to 5000ms.
+
+@PLUGIN@.maxTries
+: Maximum number of times the plugin should attempt to index the event in the
+ target instance. Setting this value to 0 will disable retries. When not
+ specified, the default value is 5. After this number of failed tries, an error
+ is logged so that admins can re-index the change manually.
+
+@PLUGIN@.retryInterval
+: The interval of time in milliseconds between the subsequent auto-retries.
+ When not specified, the default value is set to 1000ms.
+
+@PLUGIN@.threadPoolSize
+: Maximum number of threads used to send index events to the target instance.
+ Defaults to 1.
