Skip to content

Commit 08e3b89

Browse files
committed
CSD-5935 Update CSD-Theory documentation
1 parent f590885 commit 08e3b89

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ On-Site WebCSD should work with any linux OS that meets the requirements to run
4141

4242
On-Site WebCSD can be configured to read from in-house databases. To enable these databases, copy and rename the file `docker-compose.sample-db-config.yml` to `docker-compose.db-config.yml` and edit the `volumes` section to point to any in-house databases and edit the `environment` section to configure the application to recognise these databases. 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.
4343

44+
## CSD-Theory Database Configuration
45+
46+
If wanting to use WebCSD with CSD-Theory, ensure the steps in [link](#In-house Database Configuration) have been followed.
47+
There are examples of CSD-Theory configurations in the `docker-compose.sample-db-config.yml` file.
48+
4449
## Installation
4550

4651
After unpacking the release source code onto the server on which the software will be installed you will need to go into the on-site-webcsd directory and copy the environment file `sample.env` as `.env` then populate with suitable values.
@@ -59,7 +64,8 @@ CSD_DB_PASSWORD=A password of your choosing
5964
CSD_CACHE_PASSWORD=A password of your choosing
6065
```
6166

62-
Where stated, some of these variables will be provided by CCDC; all other variables are for the user to generate and set. Once the variables file has been populated, login to the CCDC container registry and bring up the stack:
67+
Where stated, some of these variables will be provided by CCDC; all other variables are for the user to generate and set.
68+
Once the variables file has been populated, login to the CCDC container registry and bring up the stack:
6369

6470
```
6571
docker login -u <user> -p <password> ccdcrepository.azurecr.io

docker-compose.sample-db-config.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ services:
8787
# volumes:
8888
# - /path/to/CSD-Theory Landscape Database:/app/databases
8989
# This will create a persistent volume and claim for the location of the landscape database.
90-
# Please refer to the README regarding additional steps required for implementing CSD Theory.
9190
#########################################################################################################
9291

9392
# IMPORTANT: The CSD Search database must also be included in the webcsdbackend volumes.
@@ -106,10 +105,12 @@ services:
106105
# to use these databases the csd-theory section of the file will look like this
107106
#
108107
# services:
109-
# csd-theory:
108+
# webcsd-theory:
110109
# volumes:
111110
# - /usr/local/data/metadata-db.db:/app/CSPDatabase.db
112111
# - /usr/local/data/landscape-db.csdsqlx:/app/databases/landscape-db.csdsqlx
112+
# environment:
113+
# - ReportSettings__CspStructureDatabaseConnectionString=/app/databases/landscape-db.csdsqlx
113114
#
114115
# Also add an entry to webcsdbackend for the landscape database
115116
#

0 commit comments

Comments
 (0)