diff --git a/README.md b/README.md index 15677a4..e1be60b 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,8 @@ Terms and conditions can be found in the `LICENSE.md` file. Additional information including user configuration and troubleshooting can be found in the wiki at . -:warning: **Note, the latest 4.3.0 release does not support CSD-Theory, Macromolecule Hub or the Prototypes plugin. Do not -update to this version if you are currently using those components.** +:warning: **Note, the 4.3.0 and 4.3.1 releases do not support Macromolecule Hub. Do not +update past version 4.2.1 if you are currently using this component.** ## Prerequisites and Setup @@ -60,7 +60,7 @@ If self-hosting the postgres server, see [Setting up a self-hosted Postgresql se for system requirements. On-Site Lattice and WebCSD should work with any OS that meets the requirements to run Docker, but official support is provided by CCDC on the following platforms. -Note that these match the 2025.3 CSD Portfolio Desktop release. +Note that these match the 2026.1 CSD Portfolio Desktop release. - RedHat Enterprise Linux 8, 9 and 10 - Rocky Linux 8, 9 and 10 @@ -96,18 +96,18 @@ sudo setenforce 0 ### Authentication -- A valid CCDC activation key (a 36-character key in the format ######-######-######-######-######-######) - will be required to use the software. +- A valid CCDC activation key (a 36-character key in the format ######-######-######-######-######-######) or local license server + URL will be required to use the software. - Connecting to your WebCSD server via https is now required. To configure this you will need a password-protected .pfx certificate. ```sh # To generate a self-signed certificate -# Generate private key (OpenSSL will prompt for a password) +# Generate private key openssl genrsa -out private.key 2048 -# Generate certificate signing request (CSR) +# Generate certificate signing request (CSR) (OpenSSL will prompt for a password) openssl req -new -key private.key -out request.csr # Generate self-signed certificate (valid for 365 days) @@ -163,15 +163,15 @@ sudo usermod -u 1397 ccdc sudo groupadd docker sudo usermod -aG docker ccdc -# The pfx certificate created earlier must be owned by the ccdc user and group and must be world-readable +# The pfx certificate created earlier must be owned by the ccdc user and group and should be only user readable sudo chown ccdc:ccdc certificate.pfx -sudo chmod 644 certificate.pfx +sudo chmod 400 certificate.pfx ``` **All installation methods (manual/installer) must be run from the `ccdc` account so that all file permissions are set up correctly.** ```sh -# For updating to 4.3.0, "ccdc" needs read access to the necessary docker volumes. +# For updating to 4.3.1, "ccdc" needs read access to the necessary docker volumes. sudo chown -R ccdc:ccdc lic sudo chown -R ccdc:ccdc userdata ``` @@ -194,21 +194,23 @@ to run either via a GUI or command-line interface. A screenshot of the On-Site WebCSD installer -3. The next screen details the components that will be installed, the current 4.3.0 release contains +3. The next screen details the components that will be installed, the current 4.3.1 release contains a single main package. A screenshot of the On-Site WebCSD installer 4. At the next stage, the configuration details required for setting up the server are required. This - includes the location of the .pfx file and the associated password, the CCDC license key and the public URI + includes the location of the .pfx file and the associated password, the CCDC license key (or local license server URL) and the public URI for the server. - If no .pfx file is provided a built-in self-signed certificate will be used. This is not recommended as it is insecure, and will not work with SSO authentication. - The public URI has the format `https://full.docker.hostname:PORT` where `full.docker.hostname` is your - Docker host and `PORT` is a port number of your choice (e.g. 443). + Docker host and `PORT` is a port number of your choice. + :information: if using the default 443 port this should *not* be included in + the URI as it may be automatically stripped from the address by the browser. A screenshot of the On-Site WebCSD installer @@ -247,6 +249,9 @@ docker compose ps which should show the state of the services to all be `Up`. If any services have the state `Up (unhealthy)` or `Exit` then restart the stack. In most cases it is best to leave the postgres server running as in the commands below. +:information: if the postgres server is kept running, the output from taking down the stack may include the warning ```!Network onsitewebcsdinstallation_default Resource is still in use``` - +this is expected and does not require further action. + ```sh # Replace `INSTALLDIR` by your WebCSD installation directory # Include docker-compose.insecure-configuration.yml if using a self-signed certificate @@ -278,15 +283,15 @@ To check that you can search the CSD you must create an account. If you have problems check your `.env` file. - The correct format for the `CCDC_LICENSING_CONFIGURATION` line is - `CCDC_LICENSING_CONFIGURATION=la-code;ACTIVATION_KEY;`. -- `PUBLIC_URI` should be set to the full URL of your WebCSD server including the port number. + `CCDC_LICENSING_CONFIGURATION=la-code;ACTIVATION_KEY;` or `CCDC_LICENSING_CONFIGURATION=lf-server;http://SERVER_NAME:PORT_NO` +- `PUBLIC_URI` should be set to the full URL of your WebCSD server, including the port number unless this is the default 443. This must resolve to your docker host. - `PLATFORM_PORT` must match the port number in `PUBLIC_URI` (default is 443). ## Further Configuration -Your On-Site WebCSD server is now up and running but you will probably need to configure user access control -and in-house databases. This is done via docker compose files +Your On-Site WebCSD server is now up and running but you will probably need to configure it, for example to set up +user access control via SSO. This is done via docker compose files (see [WebCSD Configuration Files](https://github.com/ccdc-opensource/on-site-webcsd/wiki/WebCSD-configuration-files) in the wiki). After making any changes to these files, restart the stack as described above, adding any docker compose files which you have customised into the `docker compose ... up -d` command. @@ -303,10 +308,10 @@ On-Site Lattice and WebCSD can be configured to read from in-house databases. Provided within the installation is a sample database `teaching-subset.csdsql` which can be found in the `sample-data` folder in the root of the installation. -For the latest version 4.3.0 release, details on in-house database configuration are available from the +For versions 4.3.0 and later, details on in-house database configuration are available from the [wiki](https://github.com/ccdc-opensource/on-site-webcsd/wiki/Updating-your-in‐house-databases) -For earlier releases (version 4.2.1) the following information is still applicable: +For earlier releases (version 4.2.1 and earlier) the following information is still applicable: To enable in-house databases: @@ -357,7 +362,8 @@ docker compose -f docker-compose.yml -f docker-compose.ssl.yml up -d To update your installation, run the maintenance tool and select "Update components". Click Ok when a warning message pops up. This will automatically pull the latest versions of all containers and restart the stack. -For major releases a new database dump file is shipped. The maintenance tool will prompt for the location. It will then overwrite the csd database volume with the update, please export any in-house databases beforehand. Once the update has completed they will need to be reimported within lattice -> database management. +For major releases a new database dump file is shipped. The maintenance tool will prompt for the location. It will then overwrite the csd database volume with the update, +please export any in-house databases beforehand. Once the update has completed they will need to be reimported within lattice -> database management. To update from the command line: @@ -369,7 +375,8 @@ Contact CCDC Support for the latest download link. ### Manual Updates -For major releases export any in-house databases, recreate the csd-database and [restore](https://github.com/ccdc-opensource/on-site-webcsd/wiki/Setting-up-a-self%E2%80%90hosted-PostgreSQL-server#restore-database) it with a new database dump provided by Support. +For major releases export any in-house databases, recreate the csd-database and [restore](https://github.com/ccdc-opensource/on-site-webcsd/wiki/Setting-up-a-self%E2%80%90hosted-PostgreSQL-server#restore-database) +it with a new database dump provided by Support. ```sh # Replace `INSTALLDIR` by your WebCSD installation directory @@ -394,7 +401,7 @@ To uninstall On-Site WebCSD run the GUI maintenance tool and select "Remove all ### Restart the message queue -With 4.3.0 rabbitmq needs to be rerun. If you are installing manually please run the following: +With 4.3.0 and 4.3.1 rabbitmq needs to be rerun. If you are installing manually please run the following: ```sh # Replace `INSTALLDIR` by your WebCSD installation directory