Can I integrate the Urchin Data API with IIS?

Can I integrate the Urchin Data API with IIS?

Urchin is bundled with an IIS module that can be deployed and configured to handle requests to the Urchin Data API. Here are the steps:

1. Open the registry editor and add the following key:

HKEY_LOCAL_MACHINE\SOFTWARE\Apache Axis2c\IIS ISAPI Redirector 

2. Under the new registry key, add the following entries:

• A String value with the name "axis2c_home". The value is the absolute path of the Urchin Data API home directory:

  • <urchin_install_location>\lib\api\v1 For example: C:\Program Files\Urchin6\lib\api\v1

• A String value with the name "log_file". The value is the absolute path of the log file:

  • <urchin_install_location>\var\api.log For example: C:\Program Files\Urchin6\var\api.log

• A String value with the name "log_level". Use one of the following values:

  • trace - Log trace messages
  • error - Log errors critical errors
  • info - Log info and above
  • critical - Log critical errors only
  • debug - Log debug and above
  • warning - Log warnings

  • A String value with the name "services_url_prefix". The value of this parameter must be /v1

  • A String value with the name "axis2_location". The value of this parameter must be /services

Configuration steps for IIS 5 and 5.1:

1. Using the IIS management console, add a new virtual directory with name "axis2" to the website.

2. Set physical path for this virtual directory to the following location: <urchin_install_location>\lib\api\v1 For example: C:\Program Files\Urchin6\lib\api\v1

3. When creating this new virtual directory, make it executable.

4. Using the IIS management console, add the mod_axis2_IIS.dll (found in <urchin_install_location>\lib\api\v1) as a filter on the website and restart the IIS admin service.

Configuration steps for IIS 6:

1. Using the IIS management console, add a new virtual directory with name "services" to the Urchin website.
2. Using the IIS management console, add the mod_axis2_IIS.dll as a Wildcard Script Map for the newly created virtual directory.

3. The executable should include the complete path: <urchin_install_location>\lib\api\v1\mod_axis2_IIS.dll

4. Specify any name you like for the Wildcard Script Map.
5. Uncheck the "Verify that file exists" checkbox.
6. Using the IIS management console, add the mod_axis2_IIS.dll to allowed web service extension and restart the IIS admin service.

Configuration steps for IIS 7:

1. Using the IIS management console, add the mod_axis2_IIS.dll as a module mapping under the Handler Mappings section for the website.
2. The request path must be /services/*

3. Select IsapiModule for Module parameter.

4. The executable should include the complete path: <urchin_install_location>\lib\api\v1\mod_axis2_IIS.dll

5. Specify any name you like for the Module Mapping
6. In the Request restriction, specify executable access for handler.
7. Verify that the Web service extension requested is enabled on the server.
   • Using the IIS management console, navigate to the server level and open ISAPI and CGI Restrictions.
   • In the Features view, double-click ISAPI and CGI Restrictions to verify that the Web service extension is set to Allowed.
   • If the extension is not in the list, click Add in the Actions panel.
   • In the Add ISAPI and CGI Restrictions dialog box, type the absolute path of the mod_axis2_IIS.dll file in the ISAPI or CGI Path box, or click Browse to navigate to the location of the file.
   • Check "Allow extension path to execute" to allow the restriction to run automatically.
8. Restart the IIS admin service.