Skip to content

Commit 4ef7da4

Browse files
Merge pull request #80 from ccdc-opensource/revise_docs_for_inhouse_dbs
Improved instructions for adding in-house dbs NO_JIRA
2 parents 80b4f2e + e497b37 commit 4ef7da4

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,17 @@ To enable in-house databases:
193193

194194
1. Copy and rename the file `docker-compose.sample-On-Site-only-db-config.yml` to `docker-compose.db-config.yml`
195195
2. Edit the `volumes` section of that file to point to any in-house databases and edit the `environment` section to configure the application to recognise these databases.
196+
Ensure that all instances of 'database-1' or 'database-2' are replaced with the actual database name.
197+
198+
For example, to use the 'teaching_subset.csdsql' database and have it appear as a database named 'Example', your docker-compose.db-config.yml should look like:
199+
200+
```yml
201+
volumes:
202+
- /path/to/webcsd/sample-data/teaching_subset.csdsql:/csd-data/teaching_subset.csdsql
203+
environment:
204+
- ServiceSettings__Databases__2__Name=Example
205+
- ServiceSettings__Databases__2__ConnectionString=/csd-data/teaching_subset.csdsql
206+
```
196207
197208
More information is given in the notes & example sections of the sample file. This acts as an [override file](https://docs.docker.com/compose/extends/) which you will have to include in the startup command.
198209

0 commit comments

Comments
 (0)