Skip to content

Commit 1c4d931

Browse files
committed
Added information on the data/ directory volume mount.
1 parent 93aef57 commit 1c4d931

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

documentation/Deployment.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,19 @@ instance or from Translator.
2828
the downloaded file (`snapshot.backup.tar.gz`) once it has been decompressed.
2929
5. Check the [docker-compose.yml](./docker-compose.yml) file to ensure that it is
3030
as you expect.
31-
* By default, the Docker Compose file will use the latest released version of NameRes
31+
* The Docker Compose file will use the latest released version of NameRes
3232
as the frontend. To use the source code in this repository, you will need to change
3333
the build instructions for the `nameres` service in the Docker Compose file.
34-
* By default, Solr will be given 16G of memory, which seems sufficient for testing.
34+
* Solr will be given 16G of memory, which seems sufficient for testing.
3535
If you want to run many Solr queries, you might want to increase this. To do this,
3636
you will need to change BOTH the `mem_limit` setting in the `nameres_solr` service in
3737
`docker-compose.yml` and the `SOLR_JAVA_MEM` setting.
38+
* The `docker-compose.yml` file also mounts the local `data/` directory into the Solr
39+
container as `/var/solr`. This will allow you to start a new NameRes from the same
40+
directory in the future. If you want to use a different directory, please change
41+
the `volumes` setting in the `nameres_solr` service in `docker-compose.yml`. Removing
42+
the binding will cause the Solr data to be stored in the Docker instance, and the
43+
data will be lost when the container is stopped.
3844
6. Start the Solr and NameRes pods by running `docker compose up`. By default, Docker Compose
3945
will download and start the relevant pods and show you logs from both sources. You may
4046
press `Ctrl+C` to stop the pods.

0 commit comments

Comments
 (0)