Alternative ways to setup On Site WebCSD

Running On-Site WebCSD under SSL

As this is optional, we recommend following a similar process to that described in the database configuration and user interface customisation sections. Which is to store these settings in a separate docker-compose file. You can then include this file in your startup command.

To run WebCSD using HTTPS, you will need to do the following:

1. Obtain a certificate and store it in a folder that can be referenced in the volumes section (path/to/certificate).

2. Update the following sections of the webcsd service in your docker-compose file to add HTTPS support. An example of what to add and in which section, is shown below:

  webcsd:
    environment:
      - ASPNETCORE_URLS=https://+:443;http://+:80
      - ASPNETCORE_Kestrel__Certificates__Default__Password=<password used to create certificate>
      - ASPNETCORE_Kestrel__Certificates__Default__Path=/container/path/certificate.pfx

    ports:
      - 443:443

    volumes:
      - /path/to/certificate:/container/path:ro   # with read-only attributes (:ro)

Storing the docker images in your local repository

If you want to store the docker images in your own repository follow the below steps:

1. Get a copy of this git repository as in the Prerequisites section above.

2. Run the below command to download the docker images

"Docker-compose pull"

3. For each docker image run "docker tag <oldrepo/service:version> <newrepo/service:version>" e.g.

"Docker tag ccdcrepository.azurecr.io/webcsd:0.1.6  my.internal.registry/webcsd:0.1.6"

4. Run "docker push <newrepo/service:version>" e.g.

"docker push my.internal.registry/webcsd:0.1.6"

5. Create a new docker-compose file to keep your image overrides seperate and avoid them being reverted in updates e.g. "docker-compose.service-config.yml". The file will need to contain the new image location for each service copied into a new location. e.g.

version: '3.6'

services:
  webcsdbackend:
    image: my.internal.registry/webcsdbackend:0.1.6

  webcsd:
    image: my.internal.registry/webcsd:0.1.6

  database-server:
    image: my.internal.registry/csd-database:2022.1.0.alpha1

...
etc

6. Include the new file in the startup command, so if you are also using local database configurations the command will be:

docker-compose -f docker-compose.yml -f docker-compose.db-config.yml -f docker-compose.service-config.yml up -d

Please note that process will need to be repeated to copy further updates to your local repository.