diff --git a/README.md b/README.md index 213954a3..621d1f08 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ If multiple instances are run from the same machine, additional configuration ma Certain configuration options can be adjusted by setting environment variables or by defining these variables in a `.env` file stored in the same directory as the `docker-compose.yml` file. These variables are: `APP_PORT`: port mapping for the web app server `CONTAINER_NAME`: name of the application container -`DATA_DIR`: directory to be mounted for peristent data +`DATA_DIR`: directory to be mounted for peristant data `COMPOSE_PROJECT_NAME`: assign the project name associate with the compose file - this avoids conflicts when the "same" compose file is used to manage multiple instances (e.g. when using docker sibling containers) `IMAGE`: optional, overrides the default `streamline-emr:2.0` image @@ -62,7 +62,7 @@ Each instance of the app uses its own `.env` file to specify its configuration. `INSTANCES`: a list of unique instance names `APP_PORTS`: a corresponding list of port numbers to map to the local host -Important note when using "sibling containers": the sibling container method uses the host docker socket to provide containers with access to docker. As a result, port mappings and volumne mount points all refer to the host system rather than the container from which the docker command originates. +Important note when using "sibling containers": the sibling container method uses the host docker socket to provide containers with access to docker. As a result, port mappings and volume mount points all refer to the host system rather than the container from which the docker command originates. ### Example Configuration Files The following snippet shows an `instances.conf` file with 3 instances defined. Instance `test0001-_default` will use port `3001`, `test0002-_default` will use `3002`, etc.