Configuring the combined Content Deployer
In the Content Deployer configuration file, configure where incoming packages should be retrieved from, and a number of queuing and sizing parameters. Also configure the State Store database, if necessary. In this file, you can specify configuration strings as hardcoded values or as parameters.
Procedure
- Open the file deployer-conf.xml for editing.
- In the
BinaryStoragesection, configure the properties of the temporary storage location for incoming content. You can store content on the file system or in a Redis database.To store incoming content temporarily on the file system, within the uncommented
BinaryStoragesection with itsAdapterattribute set to the valueFileSystem, set thePathproperty to the absolute path to a folder on the server on which the combined Content Deployer is installed.-
Alternatively, to store incoming content in a Redis database (from which the Content Deployer removes it after successfully completing the publish transaction), put the existing
BinaryStoragesection in comments, and uncomment theBinaryStoragesection with itsAdapterattribute set to the valueRedisBlobStorage. In this section, change the values of the various named properties as follows:Property Description HostThe host name of your Redis database server. PortThe port number of your Redis database server. PasswordThe password required to access the Redis database. TimeoutThe time period, in milliseconds, after which the Content Deployer considers the Redis database to be offline.
- In the
<Queues>section, select which Adapter you want to use for your Content Deployer queue. You can use the local file system as your queue, or use a JMS queue.To use the local file system as your queue, use the uncommented
FileSystemAdapter and set its accompanyingDestinationproperty to a folder on the server on which the combined Content Deployer is installed.-
To use a JMS queue instead, enclose the uncommented
AdapterandDestinationproperties in comment delimiters, and uncomment one of theAdapterelements with itsIdset toJMS: either the Apache ActiveMQ configuration or the AmazonSQS configuration, depending on which JMS queue software you have. Set the values for the JMS queue properties as follows:Property Description JMSConnectionFactoryBuilderClassLeave this value as is. JMSUriThe URI of your Apache ActiveMQ server (starting with tcp://) or AmazonSQS server (starting withhttps://).UsernameA user who can access the ActiveMQ or AmazonSQS server (if the server is secured and located on a different machine than the combined Content Deployer). PasswordA password for that user. ReceiveTimeoutThe number of milliseconds that ActiveMQ or AmazonSQS is prepared to wait for more data.
- In the
<State>section, specify the location and credentials of the State Store database in the form of aStorageelement. If you installed your State Store database tables in the same database as the Content Data Store (which is what happens by default), you can consult theStorageelement for the Content Data Store as found in the Storage Layer configuration file, cd_storage_conf.xml. Note that thatStorageelement has a different definition than the present one.If your State Store database is Oracle, modify theStorageto look like this:<Storage Adapter="oracle" driver="oracle.jdbc.driver.OracleDriver"> <Property Name="host" Value="HOST" /> <Property Name="port" Value="PORT" /> <Property Name="database" Value="DATABASE" /> <Property Name="user" Value="USER" /> <Property Name="password" Value="PASSWORD" /> <Property Name="validationQuery" Value="select 1 from dual" /> </Storage>Alternatively, if your State Store database is not Oracle, modify theStorageto look like this:<Storage Adapter="mssql" driver="com.microsoft.sqlserver.jdbc.SQLServerDriver"> <Property Name="host" Value="HOST" /> <Property Name="port" Value="PORT" /> <Property Name="database" Value="DATABASE" /> <Property Name="user" Value="USER" /> <Property Name="password" Value="PASSWORD" /> <Property Name="validationQuery" Value="select 1" /> </Storage>If you installed your State Store database tables in the Content Data Store database, copy the values for the properties from
Storageelement for the Content Data Store, as found in the Storage Layer configuration file, cd_storage_conf.xml.Alternatively, if you installed your State Store database separately from your Content Data Store database, set the property values as follows:- Set HOST to the host name of your database server.
- Set PORT to the port number of your database server (defaults to 1521 for Oracle, 1433 for Microsoft SQL Server).
- Set DATABASE to the name of your State Store database.
- Set USER to the username of a user with access to your State Store database.
- Set PASSWORD to the (encrypted) password of that user of your State Store database.
- SDL strongly recommends entering any sensitive strings, such as passwords, in encrypted form. You can obtain the encrypted form of a sensitive string by doing the following:
- In a command shell, navigate to a location that contains the files udp-core-BUILD.jar and udp-common-util-BUILD.jar, where
BUILDis the JAR file's build number. For example, you can find these files on the installation media in the folder Content Delivery\roles\api\rest\java\lib\ - Depending on your operating system, enter one of the following commands:
- Windows operating systems
-
java -cp udp-core-BUILD.jar;udp-common-util-BUILD.jar com.tridion.crypto.Encrypt INPUT - Unix operating systems
-
java -cp udp-core-BUILD.jar:udp-common-util-BUILD.jar com.tridion.crypto.Encrypt INPUT
where INPUT is the unencrypted string. (You may wish to redirect output to a file for easy copy-pasting of the tool's response.)
The tool returns the following kind of response:Configuration value = encrypted:9FUJ9CP81Oj63VhnJxcqx//pW3fP4bekeupIexctzcs=where the encrypted string is
encrypted:9FUJ9CP81Oj63VhnJxcqx//pW3fP4bekeupIexctzcs=
- In a command shell, navigate to a location that contains the files udp-core-BUILD.jar and udp-common-util-BUILD.jar, where
- Save and close deployer-conf.xml.
- In the Content Deployer configuration folder, open application.properties for editing.
- To change the maximum possible size of a file uploaded to Content Deployer, set the spring.servlet.multipart.maxFileSize property to a number followed by
MborKb, indicating the desired maximum size in megabytes or kilobytes, respectively. - To change the maximum possible size of a multipart/formdata request to Content Deployer, set the spring.servlet.multipart.maxRequestSize property to a number followed by
MborKb, indicating the desired maximum size in megabytes or kilobytes, respectively. - Save and close application.properties.