From f9cfc228d608ca0410e1778d004cdb4cf5ce3bd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Hedenstr=C3=B6m?= <erik@codemate.se> Date: Fri, 7 Mar 2014 22:59:44 +0100 Subject: [PATCH] Improved the documentation --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 91f6a5b..9d88b8d 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,18 @@ By default, the container downloads and installs JIRA v6.2 on the first boot. To docker run -e JIRA_VERSION=6.2 -d registry.codemate.se/jira ``` -Version 6.2 and later should work. - ### Overiding JIRA files -By providing an environment variable name `JIRA_OVERLAY` that points to a zipped tar file you can apply an overlay on the JIRA installation. This tarball will be unzipped and extracted in the root of the JIRA installation directory. The overlay enables you to add custom jira configuratios such as SSL or Crowd integration. The overlay is fetched using curl so if you need to provide basic auth credentials simply prefix the url with the credentials, for example: +By providing an environment variable name `JIRA_OVERLAY` that points to a gzipped tar file you can apply an overlay on the JIRA installation. This tarball will be unzipped and extracted in the root of the JIRA installation directory. The overlay enables you to add custom jira configuratios such as SSL or Crowd integration. + +``` +docker run -e JIRA_OVERLAY=http://10.0.0.1/jira-config.tgz -d registry.codemate.se/jira +``` + +The overlay is fetched using curl so if you need to provide basic auth credentials simply prefix the url with the credentials, for example: ``` --u username:password http://10.0.0.1/jira-config.tgz +JIRA_OVERLAY="-u username:password http://10.0.0.1/jira-config.tgz" ``` ### Combined options @@ -60,7 +64,7 @@ By providing an environment variable name `JIRA_OVERLAY` that points to a zipped The following example shows the options we use for our CI environment: ``` -docker run -name jira_server \ +docker run -name jira \ -e JAVA_OPTS=-Xmx1024m \ -e JIRA_VERSION=6.2 \ -e JIRA_OVERLAY=http://10.0.0.1/jira-config.tgz \ @@ -78,7 +82,7 @@ docker run -name jira_server \ * `JIRA_HOME` - JIRA home directory (default `/home/jira`) * `JIRA_VERSION` - The version to install an run (default `6.2`) -* `JIRA_CONFIG` - A URL pointing to an tarball overlay +* `JIRA_OVERLAY` - A URL pointing to an tarball overlay ## Exposed ports -- GitLab