1. Upgrading on IIS

This process can be run when upgrading from a Cinchy version that is not v5.0+.

1.1 Prerequisites

1. Follow this guide to take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

1.2 Upgrade Process

1. Swap out the following configs with your current instance configs:

   1. Cinchy/web.config

   2. CinchySSO/appsettings.json

   3. Log4net.config

   4. Web.config

2. Execute the following command:

iisreset -stop 

5. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

6. Execute the following command:

iisreset -start 

7. Start Cinchy in your browser.

1. Upgrading on IIS

The following process can be run when upgrading from v5.0 to v5.1 on IIS.

1.1 Prerequisites

1. Take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. Execute the following command:

iisreset -stop 

3. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

4. Execute the following command:

iisreset -start 

5. Open your Cinchy URL in your browser.

6. Ensure you can log in.

1. Upgrading on IIS

The following process can be run when upgrading any v5.x instance to v5.2 on IIS.

1.1 Prerequisites

1. Take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. Execute the following command:

iisreset -stop 

3. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

4. Execute the following command:

iisreset -start 

5. Open your Cinchy URL in your browser.

6. Ensure you can log in.

1. Upgrading on IIS

The following process can be run when upgrading any v5.x instance to Cinchy v5.3 on IIS.

1.1 Prerequisites

1. Take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. Execute the following command:

iisreset -stop 

3. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

4. Execute the following command:

iisreset -start 

5. Open your Cinchy URL in your browser.

6. Ensure you can log in.

1. Overview

The pages under this section can be used to help guide you through an upgrade of your Cinchy instance on IIS.

1. Upgrading on IIS

"SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;TrustServerCertificate=True"

The following process can be run when upgrading any v5.x instance to v5.4 on IIS.

1.1 Prerequisites

1. Take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

3. Download .NET 6.0

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. If you are upgrading to 5.4+ on an SQL Server Database, you will need to make a change to your connectionString in both your SSO and Cinchy appsettings. Adding TrustServerCertificate=True will allow you to bypass the certificate chain during validation.

   Ex:

   Copy

   "SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;TrustServerCertificate=True"

3. Execute the following command:

iisreset -stop 

4. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

5. Execute the following command:

iisreset -start 

6. Open your Cinchy URL in your browser.

7. Ensure you can log in.

1. Upgrading on IIS

The following process can be run when upgrading any v5.x instance to v5.5 on IIS.

1.1 Prerequisites

1. Take a backup of your database.

2. Extract thefor the version you wish to upgrade to.

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. If you are upgrading to 5.5 on an SQL Server Database and did not do so in any previous updates, you will need to make a change to your connectionString in both your SSO and Cinchy appsettings. Adding will allow you to bypass the certificate chain during validation.

   Ex:

3. Execute the following command:

4. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

5. Execute the following command:

6. Open your Cinchy URL in your browser.

7. Ensure you can log in.

1. Upgrading on IIS (v4 to v5+)

1.1 Prerequisites

1. to take a backup of your database.

2. Extract thefor the version you wish to upgrade to.

1.2 Update the CinchySSO appsettings.json

1. Open the C:\CinchySSO\appsettings.json file in a text editor and update the values below.

1.2.1 App Settings

1. Under AppSettings section, update the values outlined in the table.

2. Wherever you see <base url> in the value, replace this with the actual protocol (i.e. http or https) and the domain name (or ip address) you plan to use.

Ex:. if you're using https with the domain app.cinchy.co, then <base url> should be replaced with https://app.cinchy.co

Below values are only required for SSO, otherwise leave them as blank

1.2.2 Connection String

In order for the application to connect to the database, the "SqlServer" value needs to be set.

1. Find and update the value under the "ConnectionStrings" section:

1.2.3 External Identity Claim Section

Under the "ExternalIdentityClaimSection" section you'll see the following values.

These values are used for SAML SSO. If you are not using SSO, keep these values as blank

1.2.4 Serilog

1. There is a "Serilog" property that allows you to configure where it logs to. In the below code, update the following:

   1. "Name" must be set to "File" so it writes to a physical file on the disk.

   2. "Path" must be set to the file path to where you want it to log.

1.3 Update the Cinchy appsettings.json

1. Navigate to C:\Cinchy

2. Delete the appsettings.Development.json

3. Navigate to the appsettings.json file and update the following properties:

1.3.1 AppSettings

1.3.2 Connection String

In order for the application to connect to the database, the "SqlServer" value needs to be set.

1. Find and update the value under the "ConnectionStrings" section:

1.3.3 Serilog

1. There is a "Serilog" property that allows you to configure where it logs to. In the below code, update the following:

   • "Name" must be set to "File" so it writes to a physical file on the disk.

   • "Path" must be set to the file path to where you want it to log.

You can also use an alternative setting if you want to have rolling log files with retention settings by adding in the following parameters:

• Your full "Serilog" property, if you choose to use the alternative settings, would look like this, inputting your own variables as required:

1.4 Configuring the IIS Manager and Running your Upgrade

1. Open your Internet Information Services (IIS) Manager.

2. Navigate to Connections > Sites.

3. Right click on the Cinchy site and select Manage Application > Advanced Settings.

4. Change the Cinchy folder path to that of the version you're deploying.

5. Right click on the CinchySSO site and select Manage Application > Advanced Settings

6. Ensure that both Applications Pools for Cinchy and CinchySSO have their .NET CLR Versions set to No Managed Code.

7. Change the Cinchy SSO folder path to that of the version you're deploying.

8. Execute the following command:

9. Execute the following command:

10. Open your Cinchy URL in your browser.

11. Ensure that you can log in.

1. Upgrading on IIS

The following process can be run when upgrading any v5.x instance to v5.6 on IIS.

"SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;TrustServerCertificate=True"

1.1 Prerequisites

1. Take a backup of your database.

2. Extract the new build for the version you wish to upgrade to.

3. Download .NET 6.0

1.2 Upgrade Process

1. Merge the following configs with your current instance configs:

   • Cinchy/web.config

   • Cinchy/appsettings.json

   • CinchySSO/appsettings.json

   • CinchySSO/web.config

2. If you are upgrading to 5.6 on an SQL Server Database and did not do so in any previous updates, you will need to make a change to your connectionString in both your SSO and Cinchy appsettings. Adding TrustServerCertificate=True will allow you to bypass the certificate chain during validation.

   Ex:

   Copy

   "SqlServer" : "Server=MyServer;Database=Cinchy;User ID=cinchy;Password=password;Trusted_Connection=False;Connection Timeout=30;Min Pool Size=10;TrustServerCertificate=True"

3. When upgrading to 5.6, you are required to make the following changes to various appsettings.json files:

    "AppSettings": {
      "CinchyUri": "http://localhost",
      "CertificatePath": "C:\\inetpub\\wwwroot\\cinchysso\\cinchyidentitysrv.pfx",
      "CertificatePassword": "",
      "SAMLClientEntityId": "",
      "SAMLIDPEntityId": "",
      "SAMLMetadataXmlPath": "",
      "SAMLSSOServiceURL": "",
      "SAMLEncryptedCertificatePath": "",
      "SAMLEncryptedCertificatePassword": "",
      "SAMLSignCertificatePath": "",
      "SAMLSignCertificatePassword": "",
      "HstsMaxAge": 2592000,
      "HstsIncludeSubDomains": false,
      "HstsPreload": false,
      "SAMLSignCertificateMinAlgorithm": "",
      "SAMLSignCertificateSigningBehaviour": "",
      "AcsURLModule": "",
      "StsPublicOriginUri": "",
      // Add in the below "StsPrivateOriginUri". 
      //This should be the private base URL used by the .well-known discovery. 
      // If left blank will match the request URL. /cinchysso
      "StsPrivateOriginUri": "",
      "MaxRequestHeadersTotalSize": 65536,
      "MaxRequestBufferSize": 65536,
      "MaxRequestBodySize": -1,
      "MachineKeyXml": "",
      "DpApiKeyRingPath": "",
      "TlsVersion": "",
      "CinchyAccessTokenLifetime": "7.00:00:00",
      "DataChangeCallbackTimeout": 7,
      "RefreshCacheTimeInMin": 10,
      "DefaultExpirationCacheTimeInMin": 360,
      "DBType": "PostgreSQL"

    "AppSettings": {
    // Add the below "StsPrivateAuthorityUri" value.
    // This should match your private Cinchy SSO URL.
      "StsPrivateAuthorityUri": "",
   // Add the below "StsPublicAuthorityUri" value.
   // This should match your public Cinchy SSO URL. 
      "StsPublicAuthorityUri": "",
   // Add the below "CinchyPrivateUri" value.
   // This should match your private Cinchy URL.
      "CinchyPrivateUri": "",
   // Add the below "CinchyPublicUri" value.
   // This should match your public Cinchy URL.
      "CinchyPublicUri": "",
      "AllowLogFileDownload": false,
      "LogDirectoryPath": "C:\\CinchyLogs\\CinchyWeb",
      "SSOLogPath": "C:\\CinchyLogs\\CinchySSO\\log.json",
      "UseHttps": true,      
      "HstsMaxAge": 2592000,
      "HstsIncludeSubDomains": false,
      "HstsPreload": false,
      "TlsVersion": "",
      "RouteDebuggerEnabled": false,
      "RefreshCacheTimeInMin": 10,
      "DefaultExpirationCacheTimeInMin": 360,
      "DBType": "PostgreSQL",
      "StorageType": "Local", // Local | S3 | AzureBlobStorage
      "MaxRequestBodySize": 1073741824 // 1gb
    },

{
  "CinchyClientSettings": {
    "Url": "",      // Cinchy Url
    "Username": "", // For Cinchy v4 only, remove otherwise
    "Password": ""  // For Cinchy v5, this should be the password for the user connections@cinchy.com. For v4 this will be the desired user's password.
  },

  "CinchyClientSettings": {
    "Url": "", // Cinchy Url
    "Username": "", // For Cinchy v4, remove otherwise
    "Password": "" // For Cinchy v5, this should be the password for the user eventlistener@cinchy.com. For v4 this will be the desired user's password.
  }

1. Execute the following command:

iisreset -stop 

1. Replace the Cinchy and CinchySSO folders with the new build and your merged configs.

2. Execute the following command:

iisreset -start 

1. Open your Cinchy URL in your browser.

2. Ensure you can log in.