Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create a directory that will hold the certificate- and key-files ('<certificateName>.cer' and '<certificateName>.key'). For example you can run

    Code Block
    languagebash
    mkdir /storage/nginx/
  2. Obtain a certificate- and key-file from one a certificate issuer or create a self signed certificate- and key-file and move them to the directory that was just created. If you are going to use Letsencrypt certificates, see below.
  3. Update your deploy scripts (Auto-deploy script section "Script Updates").
  4. git pull the most recent version of your client specific configuration - this is crucial so the the deploy using the new mechanism works correct (please contact us to verify if your client specific repository is ready for https deployment before you continue with the deploy process).
  5. Edit the dms.conf file in the client specific git repository in the section 'HTTPS parameters'; uncomment and supplement the relevant settings; in particular add the names (without path) of your certificate files (HTTPS_CERTIFICATE, HTTPS_CERTIFICATE_KEY and, and  in the case of LetsencryptHTTPS, HTTPS_CERTIFICATE_PASSWORD, HTTPS_CHAIN but no HTTPS_CERTIFICATE_PASSWORD). Make sure the NUXEO_URL in this file does not specify a port number.
    n.b. :
    in eDMS Versions prior to 1.9.8.2.6 (more precisely in the deploy scripts herefor) the HTTPS parameters in  dms.conf needed a defined path in the settings for HTTPS. Your configuration might need some adjustment if you upgrade your eDMS to 1.9.8.2.6 or better.
  6. Run the deploy command for all containers.

Setup Nuxeolib for https://

from Nuxeolib Version 1.5 or better edit the Windows Registry with these Keys:

Code Block
languagepowershell
[HKLM/SOFTWARE/DocIntegrate/USE_HTTPS] — DWORD32 — values [0;1] (where 1 is https "on")
[HKLM/SOFTWARE/DocIntegrate/HTTPS_PORT] — DWORD32 — int value (defines port number; optional, if not present port 443 will be used)
[HKLM/SOFTWARE/DocIntegrate/SKIP_HTTPS_KEY_VALIDATION] — DWORD32 — values [0;1]

please note that you may also use these Registry Keys with HKCU

Other required setup

  1. If you access CaseBrowser directly through a web browser, such as Google Chrome, make sure that your URLs for accessing CaseBrowser do not include and ports, ie. the URL for casebrowser must be https://<dms-server>/casebrowser/ and the URL for accessing the nuxeo console must be https://<dms-server>/nuxeo/
  2. The address defined in Patricia Maintenance to access the DMS must be modified in the same manner. See Patricia Maintenance and Nuxeo Configuration, section "Configure DMS Links in Patricia Maintenance" bearing the modification outlined under item 1. in mind.
  3. Similarly, the address defined in the client side registry keys for the DocIntegrate Outlook communication to the server need to be modified for https access as per item 1. (DocIntegrateOutlook, section "Installing the registry settings on a client system")
  4. In Patricia Maintenance, Basic Configuration value 315 must not specify a port but only the server address.
  5. Make sure all client computers have DocIntegrate 2.0.9 or newer installed and running.
  6. In the PAT_DMS_SETTINGS table of the Patricia db, set https.enabled=TRUE (if this key is not present, add it) and restart the DMS.
  7. NuxeoLib 

Client side setup when self signed certificates are used

...

Edit this file and for all entries in <angle brackets> enter your own data. Copy the modified file to /storage/nginx and execute

To generate .key and .csr file:

Code Block
languagebash
openssl req -new -sha256 -out patricia-edms.csr -config SAN_CERT.conf -keyout patricia-edms.key

Replace patricia-edms.* with your chosen name; The hashing algorithm ('-sha256') can also be modified by choice.
This generates is a .key and .csr file. Send the .csr file to your CA for signing. In return, you will receive a certificate; place this in the same folder.

To generate only .csr file for an existing .key file, without altering old .key file:

Code Block
languagebash
openssl req -new -sha256 -out patricia-edms.csr -config SAN_CERT.conf -key patricia-edms.key

Replace patricia-edms.csr with your chosen name; Replace patricia-edms.key with your existing key file name; The hashing algorithm ('-sha256') can also be modified by choice.
This generates a .csr file. Send the .csr file to your CA for signing. In return, you will receive a certificate; place this in the same folder.

Either way, do Do NOT send the .key file. Make sure the key file kept secure; if your key file is shared, your security may be compromised.

...