Expected Citrix Application Pools are:

• Citrix Delivery Services Authentication

• Citrix Delivery Services Resources

• Citrix Receiver for Web

• Citrix Delivery Services

Additional Resources

Disclaimer

Use the Dispatcher Release Notes page to obtain the latest Dispatcher installation file for your operating system and web server. Dispatcher release numbers are independent of the Adobe Experience Manager release numbers and are compatible with Adobe Experience Manager 6.x, 5.x and Adobe CQ 5.x releases.

Please note that Adobe Experience Manager 6.5 requires Dispatcher version 4.3.2 or higher. That said, Dispatcher versions are independent of AEM, for example, Dispatcher version 4.3.2 is also compatible with Adobe Experience Manager 6.4.

The following file naming convention is used:

dispatcher-<web-server>-<operating-system>-<dispatcher-version-number>.<file-format>

For example, the dispatcher-apache2.4-linux-x86_64-ssl-4.3.1.tar.gz file contains Dispatcher version 4.3.1 for an Apache 2.4 web server that runs on Linux i686 and is packaged using the tar format.

The following table lists the web server identifier that is used in file names for each web server:

You should install the latest version of Dispatcher that is available for your platform. On a yearly basis, you should upgrade your Dispatcher instance to use the latest version to take advantage of product improvements.

Each archive contains the following files:

• the Dispatcher modules
• an example configuration file
• the README file that contains installation instructions and last-minute information
• the CHANGES file that lists issues fixed in current and past releases

Please check the README file for any last-minute changes / platform specific notes before starting the installation.

Microsoft Internet Information Server

Iis Recommended Configuration Manual Downloads

For information on how to install this web server, see the following resources:

• Microsoft’s own documentation on the Internet Information Server

Required IIS Components

IIS versions 8.5 and 10 require that the following IIS components are installed:

• ISAPI Extensions

Also, you must add the Web Server (IIS) role. Use Server Manager to add the role and components.

Microsoft IIS - Installing the Dispatcher module

The required archive for Microsoft Internet Information System is:

• dispatcher-iis-<operating-system>-<dispatcher-release-number>.zip

The ZIP file contains the following files:

Use the following procedure to copy the Dispatcher files to the correct location.

1. Use Windows Explorer to create the <IIS_INSTALLDIR>/Scripts directory, for example, C:inetpubScripts.

2. Extract the following files from the Dispatcher package into this Scripts directory:

   • disp_iis.dll
   • disp_iis.ini
   • One of the following files depending on if Dispatcher is working with an AEM author instance or publish instance:
     • Author instance: author_dispatcher.any
     • Publish instance: dispatcher.any

Microsoft IIS - Configure the Dispatcher INI File

Edit the disp_iis.ini file to configure the Dispatcher installation. The basic format of the .ini file is as follows:

The following table describes each property.

An example configuration:

Configuring Microsoft IIS

Configure IIS to integrate the Dispatcher ISAPI module. In IIS you use wildcard application mapping.

Configuring Anonymous Access - IIS 8.5 and 10

The default Flush replication agent on the Author instance is configured so that it does not send security credentials with flush requests. Therefore, the website that you are using a the Dispatcher cache must allow anonymous access.

If your website uses an authentication method, the Flush replication agent must be configured accordingly.

1. Open IIS Manager and select the website that you are using as the Disptcher cache.
2. Using Features View mode, in the IIS section double click Authentication.
3. If Anonymous Authentication is not enabled, select Anonymous Authentication and in the Actions area click Enable.

Integrating the Dispatcher ISAPI Module - IIS 8.5 and 10

Use the following procedure to add the Dispatcher ISAPI Module to IIS.

1. Open IIS Manager.

2. Select the website that you are using as the Dispatcher Cache.

3. Using Features View mode, in the IIS section double click Handler Mappings.

4. In the Actions panel of the Handler Mappings page, click Add Wildcard Script Map, add the following property values and then click OK:

   • Request Path: *
   • Executable: The absolute path of the disp_iis.dll file, for example C:inetpubScriptsdisp_iis.dll.
   • Name: A descriptive name for the handler mapping, for example Dispatcher.

5. In the dialog box that appears, to add the disp_iis.dll library to the ISAPI and CGI Restrictions list, click Yes.

   For IIS 7.0 and 7.5 the configuration is complete. Continue with the remaining steps if you are configuring IIS 8.0.

6. (IIS 8.0) In the list of handler mappings, select the one that you just created, and in the Actions area click Edit.

7. (IIS 8.0) In the Edit Script Map dialog box, click the Request Restrictions button.

8. (IIS 8.0) To ensure that the handler is used for files and folders that are not yet cached, deselect Invoke Handler Only If Request Is Mapped To, and then click OK.

9. (IIS 8.0) On the Edit Script Map dialog box, click OK.

Configuring Access to the Cache - IIS 8.5 and 10

Provide the default App Pool user with write-access to the folder that is being used as the Dispatcher cache.

1. Right-click the root folder of the website that you are using as the Dispatcher cache and click Properties, such as C:inetpubwwwroot.

2. On the Security tab, click Edit, and then on the Permissions dialog box, click Add. A dialog box opens for selecting user accounts. Click the Locations button, select your computer name, and then click OK.

   Keep this dialog box open while you complete the next step.

3. in IIS Manager, select the IIS site that you are using for the Dispatcher cache, and on the right side of the window click Advanced Settings.

4. Select the value of the Application Pool property and copy it to the clipboard.

5. Return to the open dialog box. In the Enter The Object Names To Select box, type IIS AppPool and then paste the contents of your clipboard. The value should look like the following example:

   IIS AppPoolDefaultAppPool

6. Click the Check Names button. When Windows resolves the user account, click OK.

7. In the Permissions dialog box for the dispatcher folder, select the account that you just added, enable all of the permissions for the account except for Full Control and click OK. Click OK to close the folder Properties dialog box.

Registering the JSON Mime Type - IIS 8.5 and 10

Use the following procedure to register the JSON MIME type, when you want Dispatcher to allow JSON calls.

1. In IIS Manager, select your web site and using Features View, double-click Mime Types.

2. If the JSON extension is not in the list, in the Actions panel click Add, enter the following property values, and then click OK:

   • File Name Extension: .json
   • MIME Type: application/json

Removing the bin Hidden Segment - IIS 8.5 and 10

Use the following procedure to remove the bin hidden segment. Web sites that are not new can contain this hidden segment.

1. In IIS Manager, select your web site and using Features View, double-click Request Filtering.
2. Select the bin segment, click Remove, and in the confirmation dialog box click Yes.

Logging IIS Messages to a File - IIS 8.5 and 10

Use the following procedure to write Dispatcher log messages to a log file instead of to the Windows Event log. You need to configure Dispatcher to use the log file, and provide IIS with write-access to the file.

1. Use Windows Explorer to create a folder named dispatcher below the logs folder of the IIS installation. The path of this folder for a typical installation is C:inetpublogsdispatcher.

2. Right-click the dispatcher folder and click Properties.

3. On the Security tab, click Edit, and then on the Permissions dialog box, click Add. A dialog box opens for selecting user accounts. Click the Locations button, select your computer name, and then click OK.

   Keep this dialog box open while you complete the next step.

4. in IIS Manager,select the IIS site that you are using for the Dispatcher cache, and on the right side of the window click Advanced Settings.

5. Select the value of the Application Pool property and copy it to the clipboard.

6. Return to the open dialog box. In the Enter The Object Names To Select box, type IIS AppPool and then paste the contents of your clipboard. The value should look like the following example:

   IIS AppPoolDefaultAppPool

7. Click the Check Names button. When Windows resolves the user account, click OK.

8. In the Permissions dialog box for the dispatcher folder, select the account that you just added, enable all of the permissions for the account except for Full Control, and click OK. Click OK to close the folder Properties dialog box.

9. Use a text editor to open the disp_iis.ini file.

10. Add a line of text similar to the following example to configure the location of the log file and then save the file:

Next Steps

Before you can start using the Dispatcher you must know:

• Configure Dispatcher
• Confgure AEM to work with Dispatcher.

Apache Web Server

Instructions for installation under both Windows and Unix are covered here. Please be careful when performing the steps.

Installing Apache Web Server

For Information about how to install an Apache Web Server read the installation manual - either online or in the distribution.

If you are creating an Apache binary by compiling the source files, make sure that you turn on dynamic modules support. This can be done by using any of the –enable-shared options. At a minimum include the mod_so module.

More information can be found in the Apache Web Server installation manual.

Also see the Apache HTTP Server Security Tips and Security Reports.

Apache Web Server - Add the Dispatcher Module

The Dispatcher comes as either:

• Windows: a Dynamic Link Library (DLL)
• Unix: a Dynamic Shared Object (DSO)

The installation archive files contains the following files - dependent on whether you have selected Windows or Unix:

Use the following steps to add Dispatcher to your Apache Web Server:

1. Place the Dispatcher file in the appropriate Apache module directory:

   • Windows: Place disp_apache<x.y>.dll<APACHE_ROOT>/modules
   • Unix: Locate either the <APACHE_ROOT>/libexec or <APACHE_ROOT>/modulesdirectory according to your installation.
     Copy dispatcher-apache<options>.so into this directory.
     To simplify long-term maintenance you can also create a symbolic link named mod_dispatcher.so to the Dispatcher:
     ln -s dispatcher-apache<x>-<os>-<rel-nr>.so mod_dispatcher.so

2. Copy the dispatcher.any file to the <APACHE_ROOT>/conf directory.

   Note: You can place this file in a different location, as long as the DispatcherLog property of the Dispatcher module is configured accordingly. (See Dispatcher-Specific Configuration Entries below.)

Apache Web Server - Configure SELinux Properties

If you are running Dispatcher on RedHat Linux Kernel 2.6 with SELinux enabled, you might run into error messages like this in the dispatcher logfile.

Mon Jun 30 00:03:59 2013] [E] [16561(139642697451488)] Unable to connect to backend rend01 (10.122.213.248:4502): Permission denied

This is likely due to an enabled SELinux security. Then you you need perform the following tasks:

• Configure the SELinux context of the dispatcher module file.
• Enable HTTPD scripts and modules to make network connections.
• Configure the SELinux context of the docroot, where the cached files are stored.

Enter the following commands in a terminal window, replacing [path to the dispatcher.so file] with the path to the Dispatcher module that you installed to Apache Web Server, and path to the docroot with the path where the docroot is located (e.g. /opt/cq/cache):

Apache Web Server - Configure Apache Web Server for Dispatcher

The Apache Web Server needs to be configured, using httpd.conf. In the Dispatcher installation kit you will find an example configuration file named httpd.conf.disp<x>.

These steps are compulsory:

1. Navigate to <APACHE_ROOT>/conf.

2. Open httpd.conffor editing.

3. The following configuration entries must be added, in the order listed:

   • LoadModule to load the module on start up.
   • Dispatcher-specific configuration entries, including DispatcherConfig, DispatcherLog and DispatcherLogLevel.
   • SetHandler to activate the Dispatcher. LoadModule.
   • ModMimeUsePathInfo to configure behavior of mod_mime.

4. (Optional) It is recommended that you change the owner of the htdocs directory:

   • The apache server starts as root, though the child processes start as daemon (for security purposes). The DocumentRoot (<APACHE_ROOT>/htdocs) must belong to the user daemon:

LoadModule

The following table lists examples that can be used; the exact entries are according to your specific Apache Web Server:

The first parameter of each statement must be written exactly as in the above examples.

See the example configuration files provided and the Apache Web Server documentation for full details about this command.

Dispatcher specific configuration entries

The Dispatcher-specific configuration entries are placed after the LoadModule entry. The following table lists an example configuration that is applicable for both Unix and Windows:

Windows & Unix

The individual configuration parameters:

Path entries are relative to the root directory of the Apache Web Server.

The default settings for the Server Header are: ServerTokens Full DispatcherNoServerHeader 0
Which shows the AEM version (for statistical purposes). If you want to disable such information being available in the header you can set: ServerTokens Prod
See the Apache Documentation about ServerTokens Directive (for example, for Apache 2.4) for more information.

Iis Recommended Configuration Manual Download Windows 10

SetHandler

After these entries you must add a SetHandler statement to the context of your configuration ( <Directory>, <Location>) for the Dispatcher to handle the incoming requests. The following example configures the Dispatcher to handle requests for the complete website:

Windows and Unix

The following example configures the Dispatcher to handle requests for a virtual domain:

Windows

Unix

The parameter of the SetHandler statement must be written exactly as in the above examples, as this is the name of the handler defined in the module.

See the example configuration files provided and the Apache Web Server documentation for full details about this command.

ModMimeUsePathInfo

After the SetHandler statement you should also add the ModMimeUsePathInfo definition.

The ModMimeUsePathInfo parameter should only be used and configured if you are using Dispatcher version 4.0.9, or higher.

(Note that Dispatcher version 4.0.9 has been released in 2011. If you are using an older version, upgrading to a recent Dispatcher version would be appropriate).

The ModMimeUsePathInfo parameter should be set On for all Apache configurations:

ModMimeUsePathInfo On

The mod_mime module (see for example, Apache Module mod_mime) is used to assign content metadata to the content selected for an HTTP response. The default setup means that when mod_mime determines the content type, only the part of the URL that maps to a file or directory will be considered.

When On, the ModMimeUsePathInfo parameter specifies that mod_mime is to determine the content type based on the complete URL; this means that virtual resources will have metainformation applied based on their extension.

The following example activates ModMimeUsePathInfo:

Windows and Unix

Iis Recommended Configuration Manual Download Pdf

Enable Support for HTTPS (Unix and Linux)

Dispatcher uses OpenSSL to implement secure communication over HTTP. Starting from Dispatcher version 4.2.0, OpenSSL 1.0.0 and OpenSSL 1.0.1 are supported. Dispatcher uses OpenSSL 1.0.0 by default. To use OpenSSL 1.0.1, use the following procedure to create symbolic links so that Dispatcher uses the OpenSSL libraries that are installed.

1. Open a terminal and change the current directory to the directory where the OpenSSL libraries are installed, for example:

2. To create the symbolic links, enter the following commands:

If you are using a customized version of Apache, make sure Apache and Dispatcher are compiled using the same version of OpenSSL.

Next Steps

Before you can start using the Dispatcher you must now:

• Configure Dispatcher
• Confgure AEM to work with Dispatcher.

Sun Java System Web Server / iPlanet

Instructions for both Windows and Unix environments are covered here.

Please be careful when selecting which to execute.

Sun Java System Web Server / iPlanet - Installing your Web Server

For full information on how to install these web servers, please refer to their respective documentation:

• Sun Java System Web Server
• iPlanet Web Server

Sun Java System Web Server / iPlanet - Add the Dispatcher Module

Iis Recommended Configuration Manual Download Windows 7

The Dispatcher comes as either:

• Windows: a Dynamic Link Library (DLL)
• Unix: a Dynamic Shared Object (DSO)

The installation archive files contains the following files - dependent on whether you have selected Windows or Unix:

Use the following steps to add the Dispatcher to your web server:

1. Place the Dispatcher file in the web server’s plugin directory:

Sun Java System Web Server / iPlanet - Configure for the Dispatcher

The web server needs to be configured, using obj.conf. In the Dispatcher installation kit you will find an example configuration file named obj.conf.disp.

1. Navigate to <WEBSERVER_ROOT>/config.

2. Open obj.conffor editing.

3. Copy the line that starts:
   Service fn='dispService'
   from obj.conf.disp to the initialization section of obj.conf.

4. Save the changes.

5. Open magnus.conf for editing.

6. Copy the two lines that start:
   Init funcs='dispService, dispInit'
   and
   Init fn='dispInit'
   from obj.conf.disp to the initialization section of magnus.conf.

7. Save the changes.

The following configurations should all be on one line and the $(SERVER_ROOT) and $(PRODUCT_SUBDIR) must be replaced by the respective values.

Init

The following table lists examples that can be used; the exact entries are according to your specific web server:

Windows and Unix

where:

Depending on your requirements you can define the Dispatcher as a service for your objects. To configure the Dispatcher for your entire website modify the default object:

Windows

Unix

Next Steps

Before you can start using the Dispatcher you must now:

• Configure Dispatcher
• Confgure AEM to work with Dispatcher.