IIS
This guide serves as a walkthrough of how to deploy v5 on IIS.
Last updated
Was this helpful?
This guide serves as a walkthrough of how to deploy v5 on IIS.
Last updated
Was this helpful?
Cinchy version 5 on IIS comes bundled with common components such as Connections, Meta Forms, and the Event Listener. This page details the configuration and deployment instructions for the Cinchy Platform, including SSO.
SQL SERVER 2017+
SSMS (optional)
Install IIS 7.5+ / enable IIS from Windows features
Dotnet 6
Dotnet 7 isn't supported with Cinchy 5.x
2 × 2 GHz Processor
8 GB RAM
4 GB Hard Disk storage available
4 × 2 GHz Processor
12 GB RAM
Hard disk storage dependent upon use case. Cinchy maintains historical versions of data and performs soft deletes which will add to the storage requirements.
Access to Cinchy.net (Cinchy Prod) can be obtained during onboarding.
Navigate to the Cinchy Releases table from the Cinchy user interface.
Download the following items from the "Release Artifacts" column:
Cinchy VX.X.zip
Cinchy Connection
Cinchy Event Listener
Cinchy Meta-Forms (optional)
Cinchy Maintenance CLI (optional)
On your SQL Server 2017+ instance, create a new database and name it Cinchy.
If you choose an alternate name, use the name in the rest of the instructions instead of **Cinchy**.
Create a single user account with db_owner privileges
for Cinchy to connect to the database. If you choose to use Windows Authentication instead of SQL Server Authentication, the authorized account must be the same account that runs the IIS Application Pool.
On the Windows Server machine, launch an instance of PowerShell as Administrator.
Verify Db_name → Security → Users → select the user → properties → membership
If you use Windows Authentication in the database or want to run the application under a different user account, execute the commands below to change the application pool identity.
Make sure your application pool accounts has read and execute access to these directories.
Run the below commands in the Administrator instance of PowerShell to create separate directories for Errorlogs and Logs.
Open the C:\CinchySSO\appsettings.json
file in a text editor and update the values below.
Under AppSettings section, update the values outlined in the table.
CinchyUri
The base URL appended with /Cinchy
.
http://localhost/Cinchy
, {base_cinchy_url}/Cinchy
CertificatePath
Path to the CinchySSO v5 folder for the certificate.
C:\\CinchySSO\\cinchyidentitysrv.pfx
StsPublicOriginUri
Base URL of the .well-known
discovery.
http://localhost/CinchySSO
, {base_cinchy_url}/CinchySSO
StsPrivateOriginUri
Private Base URL of the .well-known
discovery.
http://localhost/CinchySSO
, {base_cinchy_url}/CinchySSO
CinchyAccessTokenLifetime
Duration for the Cinchy Access Token in v5.4+. Defaults to 7.00:00:00
(7 days).
7.00:00:00
DB Type
Database type. Either PostgreSQL
or TSQL
.
For SQLSERVER installation:TSQL
To connect the application to the database, you must set the SqlServer
value.
Find and update the value under the "ConnectionStrings" section:
Cinchy has a serilog
property that configures where the logs are located. In the below code, update the following:
"Name"
must be set to "File" so it writes to a physical file on the disk.
Set "path"
to the file path to where you want it to log.
Replace "WriteTo"
section with following:
Navigate to the installation folder for Cinchy (C:\Cinchy).
Open the appsettings.json file and update the following properties:
StsPrivateAuthorityUri
Match your private Cinchy SSO URL.
http://localhost/CinchySSO
, {base_cinchy_url}/CinchySSO
StsPublicAuthorityUri
Match your public Cinchy SSO URL.
http://localhost/CinchySSO
, {base_cinchy_url}/CinchySSO
CinchyPrivateUri
Match your private Cinchy URL.
http://localhost/Cinchy
, {base_cinchy_url}/CinchySSO
CinchyPublicUri
Match your public Cinchy URL.
http://localhost/Cinchy
, {base_cinchy_url}/Cinchy
UseHttps
Use HTTPS.
false
DB Type
Database type.
TSQL
MaxRequestBodySize
Introduced in Cinchy v5.4. Sets file upload size for the Files API. Defaults to 1G.
1073741824 // 1g
LogDirectoryPath
Match your Web/IDP logs folder path.
C:\\CinchyLogs\\CinchyWeb
SSOLogPath
Match your SSO log folder path.
C:\\CinchyLogs\\CinchySSO\\log.json
To connect the application to the database, the SqlServer
value needs to be set.
Open an administrator instance of PowerShell.
Execute the below commands to create the IIS applications and enable anonymous authentication. (This is required to allow authentication to be handled by the application).
Access the <base url>/Cinchy
(http://app.cinchy.co/Cinchy) through a web browser.
Once the login screen appears, enter the credentials:
The default username is admin and the password is cinchy.
You will be prompted to change your password the first time you log in.
Navigate to the following sub-pages to deploy the following bundled v5 components:
Alternatively, users can request access by sending an email to .
For more information about creating a database in SQL server, see the .
Copy and run the PowerShell snippet below to create the application pool and set its priorities. You can also manually create the app pool via the .
Download and unzip the "Cinchy vX.X" application package from the . This will create two directories: Cinchy
and CinchySSO
. For example, if you unzip at the root of your C drive, the two directories will be C:\Cinchy
and C:\CinchySSO
.
For more information on the SSO installation, please seee the