WebCSD configuration files

Introduction

WebCSD configuration is handled via a number of .yml files which can be included as part of the docker compose command when bringing up the stack e.g.

docker compose -f docker-compose.yml -f file1.yml -f file2.yml up -d

docker-compose.yml is the main configuration file. We do not recommend editing it - instead put your changes in a separate "override file" and add it into the docker compose command. Example changes are listed at WebCSD Configuration And Customisation.

Configuration files other than the main file may be renamed, particularly those with "sample" in the name. Which of these files you need to use depends on your WebCSD configuration. To secure connections via SSL which is now compulsory, you will need to make sure your SSL certificate has been set up, then edit docker-compose.sample.ssl.yml to point to your certificate files and include it in the docker compose command. More details are given at Configuring SSL.

Files relating to databases

• If using in-house databases without CSP, edit and include docker-compose.sample-onsite-only-db-config.yml.
• If using in-house databases with CSP, edit and include docker-compose.sample-csd-theory-db-config.yml.
• If using Macromolecule Hub, include docker-compose.macromolecule-hub.yml (do not edit it).

Files relating to user access control

• For SSO (single sign-on), edit and include docker-compose.sample-enable-sso.yml.
• For LDAP, also edit and include docker-compose.sample.ldap.yml.
• To disable the user access control, include docker-compose.disable-user-access.yml (do not edit it).