From 3d18425d2a80ed0def14e30e6c979f2378733d3d Mon Sep 17 00:00:00 2001 From: "Daniel M. Drucker" Date: Thu, 8 Apr 2021 12:52:01 -0400 Subject: [PATCH] use .env-dist as an example. closes #70 --- .env => .env-dist | 2 +- .gitignore | 1 + README.md | 6 ++++-- 3 files changed, 6 insertions(+), 3 deletions(-) rename .env => .env-dist (93%) diff --git a/.env b/.env-dist similarity index 93% rename from .env rename to .env-dist index d72b5fb..9630d77 100644 --- a/.env +++ b/.env-dist @@ -18,4 +18,4 @@ XNAT_ACTIVEMQ_PASSWORD=password TOMCAT_XNAT_FOLDER=ROOT XNAT_ROOT=/data/xnat XNAT_HOME=/data/xnat/home -XNAT_EMAIL=harmitage@miskatonic.edu +XNAT_EMAIL=your_admin_email@example.com diff --git a/.gitignore b/.gitignore index 14dd7e9..44df0e7 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,7 @@ gradle.properties # Ignore log and env files, as well as mounted data folders and plugin folders. *.log *.env +.env *-data/ xnat/plugins diff --git a/README.md b/README.md index 2c95c6e..0afc064 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,9 @@ $ cd xnat-docker-compose * If you need to control some arguments that get sent to tomcat on startup, you can modify the `CATALINA_OPTS` environment variable (under `services → xnat-web → environment`). - **xnat/Dockerfile**: Builds the xnat-web image from a tomcat docker image. -3. Start the system +3. Copy `.env-dist` to `.env` and edit it for your site. + +4. Start the system ``` $ docker-compose up -d @@ -102,7 +104,7 @@ When you bring up XNAT with `docker-compose up`, several directories are created To support differing deployment requirements, `xnat-docker-compose` uses variables for settings that tend to change based on environment. By default, `docker-compose` takes the values for variables from the [file `.env`](https://docs.docker.com/compose/environment-variables/). Advanced configurations will need to use a customized `.env` file. -To create your own `.env` file, it's best to just copy the existing `.env` and modify the values in there. +You should copy `.env-dist` to `.env` and modify the values in there. ### XNAT configuration