Skip to content

Commit

Permalink
Updated XNAT references to v1.8.2. Addressed #70 by moving .env file …
Browse files Browse the repository at this point in the history
…to default.env. This matches the pattern used on the dependency-mgmt branch.
  • Loading branch information
kelseym committed May 20, 2021
1 parent f321354 commit 2ac742d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ gradle.properties

# Ignore log and env files, as well as mounted data folders and plugin folders.
*.log
*.env
*-data/
xnat/plugins

Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,20 @@ $ git clone https://github.com/NrgXnat/xnat-docker-compose
$ cd xnat-docker-compose
```

2. Configurations: The default configuration is sufficient to run the deployment. The following files can be modified if you want to change the default configuration
2. Set Docker enviroment variables: Default and sample enviroment variables are provided in the default.env file. Add these variables to your environment or simply copy `default.env` to `.env` . Values in this file are used to populate dollar-notation variables in the docker-compose.yml file.
```
$ cp default.env .env
```

3. Configurations: The default configuration is sufficient to run the deployment. The following files can be modified if you want to change the default configuration

- **docker-compose.yml**: How the different containers are deployed. There is a section of build arguments (under `services → xnat-web → build → args`) to control some aspects of the build.
* If you want to download a different version of XNAT, you can change the `XNAT_VER` variable to some other release.
* The `TOMCAT_XNAT_FOLDER` build argument is set to `ROOT` by default; this means the XNAT will be available at `http://localhost`. If, instead, you wish it to be at `http://localhost/xnat` or, more generally, at `http://localhost/{something}`, you can set `TOMCAT_XNAT_FOLDER` to the value `something`.
* 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
4. Start the system

```
$ docker-compose up -d
Expand Down Expand Up @@ -81,7 +86,7 @@ xnat-web_1 | INFO: Server startup in 84925 ms
```


4. First XNAT Site Setup
5. First XNAT Site Setup

Your XNAT will soon be available at http://localhost.

Expand Down Expand Up @@ -110,7 +115,7 @@ These variables directly set options for XNAT itself.

Variable | Description | Default value
-------- | ----------- | -------------
XNAT_VERSION | Indicates the version of XNAT to install. | 1.8.1
XNAT_VERSION | Indicates the version of XNAT to install. | 1.8.2
XNAT_MIN_HEAP | Indicates the minimum heap size for the Java virtual machine. | 256m
XNAT_MAX_HEAP | Indicates the maximum heap size for the Java virtual machine. | 4g
XNAT_SMTP_ENABLED | Indicates whether SMTP operations are enabled in XNAT. | false
Expand Down
2 changes: 1 addition & 1 deletion .env → default.env
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
XNAT_VER=1.8.1
XNAT_VER=1.8.2
XNAT_MIN_HEAP=256m
XNAT_MAX_HEAP=4g
XNAT_SMTP_ENABLED=false
Expand Down

0 comments on commit 2ac742d

Please sign in to comment.