Skip to content

use .env-dist as an example. closes #70 #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

use .env-dist as an example. closes #70 #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env → .env-dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ XNAT_ACTIVEMQ_PASSWORD=password
TOMCAT_XNAT_FOLDER=ROOT
XNAT_ROOT=/data/xnat
XNAT_HOME=/data/xnat/home
XNAT_EMAIL=[email protected]
XNAT_EMAIL=[email protected]
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down