diff --git a/README.md b/README.md index 0e8990f8f6f22a342d6e51bb0fe340201371421b..c45f4aee620f16efa535499bc5ff74bddd218ab6 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,6 @@ services: environment: - MYSQL_USER=xwiki - MYSQL_PASSWORD=xwiki - - MYSQL_DATABASE=xwiki db: image: "mysql:5" volumes: @@ -84,6 +83,16 @@ volumes: # Details for xwiki-mysql-tomcat +## Configuration Options + +The first time you create a container out of the xwiki image, a shell script (/usr/local/bin/start_xwiki.sh`) is +executed in the container to setup some configuration. The following environment variables can be passed: + +* `MYSQL_USER`: The MySQL user name used by XWiki to read/write to the DB. +* `MYSQL_PASSWORD`: The MySQL user password used by XWiki to read/write to the DB. + +## Miscellaneous + Volumes: * Two volumes are created: * A volume named `<prefix>_mysql-data` that contains the database data.