Install CrudeSync

In this section you will learn: How to set up the CrudeSync web application.

The CrudeSync files are contained in a folder called <date>_CrudeSyncYml_<VersionNumber>.<build>, for example 20240404_CrudeSyncYml_2024.2.24095.5_2024.2. This folder is referred to as <CrudeSyncFolder> in the remainder of this manual.

1. Copy the <CrudeSyncFolder> folder into a suitable location, for example \Web\SpiralSuite\CrudeSync.

2. Extract the CrudeSyncCore.zip package in the <CrudeSyncFolder> folder. These instructions assume you extract the package into a CrudeSyncCore subfolder.

3. Open a command prompt or PowerShell console in the <CrudeSyncFolder>\DatabaseUpgrade\net8.0 folder and run the following command, replacing <ServerName> with the location of your database server. If you have chosen not to enable SQL Server TLS, add Encrypt=False; to the ConnectionString string.

   Spiral.DatabaseUpgrade.Console.exe AlterDBUpgrade /AlterDBPath=".\Scripts" /ConnectionString="Integrated Security=SSPI; Persist Security Info=False; Initial Catalog=CrudeSync; Data Source=<ServerName>;" /FirstAlterDBToRun=AlterDb70.sql

   Note that <ServerName> should include the instance, if appropriate. Make sure to escape any backslashes: for example, write Data Source=.\\SQL2017 instead of Data Source=.\SQL2017. Also, beware of line breaks in the printed version of this document: the above is one command on a single line.

4. Open Internet Information Services (IIS) Manager. At the root level, open Feature Delegation:

   

5. If needed, modify the setting for Authentication - Windows from Read Only to Read/Write:

   

6. Using the IIS Manager, browse to <ServerName>\Application Pools.

7. Create a new CrudeSync Application Pool:

   • Choose No Managed Code as .NET CLR version.

   • Choose Integrated as Managed pipeline mode.

     

8. Close the Add Application Pool dialog box and right-click on the CrudeSync application pool you just created. Choose Advanced Settings. The Advanced Settings dialog box opens.

9. Click the Identity entry under Process Model. Click the ellipsis button () that appears at the end of the row. The Application Pool Identity dialog box opens.

10. From the Built-in account list, select NetworkService. Click OK.

11. Back in the IIS Manager, right-click on Default Web Site under Sites and select Add Application from the context menu.

12. Enter CrudeSync as the Alias.

13. Select the CrudeSync Application Pool.

    

14. Set the Physical path to point to the CrudeSync folder (D:\Web\SpiralSuite\CrudeSync\<CrudeSyncFolder>\CrudeSyncCore).

15. Click OK to close the Add Application dialog box.

16. Select the CrudeSync web application and double-click the Authentication icon.

    

17. Set Windows Authentication to Enabled and all other authentication types to Disabled.

18. Right-click on CrudeSync under Default Web Site and choose Edit Permissions. The CrudeSyncCore Properties dialog box opens. Set the NTFS permissions of the folder as follows:

    1. Select the Security tab, click the Edit button and click Add.

    2. Click Locations, select the host server name then click OK.

    3. Enter IIS Apppool\CrudeSync and click Check Names.

    4. Click OK.

    5. Grant the Application Pool Identity (in this case NetworkService) modify permission on the folder.

19. Create an appSettings.Production.json file in the same folder as appsettings.json, with the following contents:

    {
    "ApplicationSettings": {
    "SpiralHomePageUrl": "/assay/",
    "NativeConnection": {
    "ConnectionString": "Provider=MSOLEDBSQL;Data Source=<ServerName>;Initial Catalog=CrudeSync;Integrated Security=SSPI;"
    },
    "NetConnection": {
    "ConnectionString": "Data Source=<ServerName>;Initial Catalog=CrudeSync;Integrated Security=SSPI;"
    },
    "Root": "/CrudeSync",
    "UserAuthType": "Windows"
    },
    "AdminSettings": {
    "Administrators": [
    "DOMAIN\\user1",
    "DOMAIN\\user2"
    ]
    }
    }
    

    If you have chosen not to enable SQL Server TLS, add Encrypt=False; to the ConnectionString strings.

    Note that <ServerName> should include the instance, if appropriate. Make sure to escape any backslashes: for example, write Data Source=.\\SQL2017 instead of Data Source=.\SQL2017. In the Administrators section enter at least one user as administrator.

    Also, beware of line breaks in the printed version of this document: the strings between double quotes must not have any line breaks. Note that Initial Catalog is two words separated by a space.

20. Browse to http://localhost/CrudeSync. You should see the following screen if correctly configured:

    

21. Browse to the CrudeSync URL from another machine using the external URL. You should see the same screen as before if correctly configured.

    Note: Additionally, you can restrict the list of users with access to the CrudeSync web service through modification of NTFS permissions, or with the Authorization Rules feature of IIS.

22. Select the CrudeSync web application.

23. Open the Authorization Rules feature in IIS.

    

24. Remove all existing rules.

25. Right-click and choose Add allow rule.

26. Select Specified roles or user groups.

27. Enter the name of an Active Directory group containing the required users accounts.

28. Click OK.