Explain how adding an external-mount may change first-run behaviour
It is common for /var/gerrit/etc to be externally mounted to an
initially empty directory on the host. If that is done, then the
special copy of gerrit.config that comes from the deb/rpm package
won't be found when gerrit starts. Gerrit will generate a new config,
but it will not contain the special settings present in the one from
the deb/rpm package and the start-up behaviour will be different
(e.g. the "admin" user will not be automatically created, and
plugin-manager will not show the welcome screen). Add a note
explaining this. Also, add a link to help readers understand that
"out-of-the-box" refers to a plugin.
Change-Id: I2aac83fe822e629a3409136f52d87232dfce5661
diff --git a/README.md b/README.md
index b1ef8c6..e304321 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
# Gerrit Code Review docker image
-The official Gerrit Code Review image with an out-of-the-box setup
-with H2 and DEVELOPMENT account setup.
+The official Gerrit Code Review image with an
+[out-of-the-box](https://gerrit.googlesource.com/plugins/out-of-the-box/)
+setup with H2 and DEVELOPMENT account setup.
This image is intended to be used AS-IS for training or staging environments.
It can be used for production as base image and requires customizations to its gerrit.config
@@ -111,9 +112,16 @@
cache-volume:
```
-
Run ```docker-compose up``` to trigger the build and execution of your custom Gerrit docker setup.
+Note that the path `/var/gerrit/etc` may also be externally-mounted. If this is done, then
+the config file `/var/gerrit/etc/gerrit.config` initialized by the Gerrit deb/rpm
+package inside the container will no longer be available. If gerrit does not find an existing
+`gerrit.config` file under the externally-mounted path, then it generates a new one. Note that the
+newly generated config file does not provide the same first-run behaviour as the one from the
+deb/rpm package (the out-of-the-box plugin is not configured, and the introductory screen of
+the plugin-manager will not appear).
+
## Environment variables
This is a list of available environment variables to change the Gerrit configuration:
