Configuration

Once the Swift publication module is installed, you must ensure its configuration is aligned with your business needs and production environment.

  1. Ensure that your public receivers are configured.

  2. Configure REST communication between author and public instances.

  3. Decide on an external version store, such as S3, and configure it.

Receivers

First, make sure you have receivers configured correctly in a properties file.

swift.publication.receivers[0].name=public1 
swift.publication.receivers[0].url=http://public1:8080/magnoliaPublic
swift.publication.receivers[0].enabled=true
swift.publication.receivers[1].name=public2 
swift.publication.receivers[1].url=http://public2:8080/magnoliaPublic
swift.publication.receivers[1].enabled=true

This node name is used for the queue naming setup.

Similar to other modules, defining your public instances for the workflow is mandatory. You can change the public instance name for the hostname in development environments.

Communication between instances

REST-based publication

For REST communication, you need to add JVM arguments/magnolia properties for sensitive data as credentials.

The REST publication requires an API key to control access. APIs allow two software modules to exchange data and are used here for publication between author and public instances.

Example configuration for the JVM argument
-Daws.retryMode=standard (1)
1 This changes the default legacy mode to the standard retry strategy.

Properties

swift.publication.rest
Property Description

aws.retryMode

optional, default is legacy

  • The default legacy mode in S3 retries four times if no retry configuration is set.

  • A standard retry strategy can be configured via profile settings, environment variables, or JVM system properties, as detailed in the Specify a strategy section of the AWS SDK for Java documentation.

swift.publication.rest.authentication.signature.enabled

optional, default is true

This property is for secure request handling by sending signatures from the author instance, verified by public instances using a public key.

If set to false, the signature mechanism is disabled, and only requests from localhost are permitted. This property must have consistent values across both the author and public instances.

When authentication is enabled, the public key must be deployed to public instances under /server/activation/publicKey. Swift publication doesn’t automatically propagate the key on the initial publication. You must add it manually if it’s missing.

swift.publication.rest.retry.attempts

optional, default is 3

Configures the number of REST retries upon publication request failures.

swift.publication.rest.executor.retry.poolSize

optional, default is 3

The size of the scheduled thread pool used for REST retries.

swift.publication.rest.retry.interval

optional, default is 2

The interval between REST retry attempts in milliseconds.

swift.publication.rest.retry.statusCodes

optional, default is 408,429,500,502,503,504

REST retries are attempted for the status codes defined in this property.

Default codes are set according to Google retry strategy. The list includes the following HTTP status codes:

  • 408 Request Timeout

  • 429 Too Many Requests

  • 500 Internal Server Error

  • 502 Bad Gateway

  • 503 Service Unavailable

  • 504 Gateway Timeout

swift.publication.rest.sync.poll.interval

optional, default is 3000

This property defines the time between retry synchronisation polling in milliseconds.

swift.publication.rest.sync.status.timeout

optional, default is 3600

Timeout for status synchronizations between author and public instances in seconds.

swift.publication.save.bulk.size

optional, default is 50

Defines the number of items processed in bulk in publishing and unpublishing operations. This has several performance advantages:

  • Preventing JVM memory and CPU overload

  • Reduced risk of timeouts and partial failures

  • Minized database locking and contention by keeping transactions shorter

Versioning store

Amazon S3

For Amazon S3 credentials, find details in the AWS connection section below.

You can store properties in all property sources, such as system properties or the magnolia.properties file example below.
/apache-tomcat/webapps/magnoliaAuthor/WEB-INF/config/default/magnolia.properties
swift.versioning.s3.bucket=<YOUR_S3_BUCKET> (1)
swift.versioning.s3.region=<AWS_REGION> (2)
swift.versioning.s3.rootFolder=<YOUR_FOLDER> (3)
swift.versioning.s3.connection-acquire-timeout: <YOUR_CONNECTION_ACQUIRE_TIMEOUT> (4)
swift.versioning.s3.max-connections=<YOUR_MAX_CONNECTIONS> (5)
swift.versioning.s3.max-connection-acquires=<YOUR_MAX_CONNECTION_ACQUIRES> (6)
swift.versioning.s3.rate-limit-period=<YOUR_RATE_LIMIT_PERIOD> (7)
swift.versioning.s3.rate-limit=<YOUR_RATE_LIMIT> (7)
swift.versioning.s3.rate-limit-timeout=<YOUR_RATE_LIMIT_TIMEOUT> (7)
1 Specify your S3 bucket name.
2 Specify the AWS Region you’re using.
3 If you want to reuse the same bucket across different environments, like test or production, you can save your publications in a different space per environment. You can do this by modifying the root folder as a base folder for publication storage.
4 Timeout in seconds for acquiring an S3 connection from the pool.
5 Maximum number of S3 connections in the pool.
6 Maximum number of pending requests when the pool is empty.
7 Configuring the request rate limit.
AWS S3 bucket names are globally unique, meaning no two buckets can have the same name. If you try to create a bucket and receive an error stating the bucket already exists, it means that the bucket name is already in use, either by you or someone else.

Properties

Amazon S3 properties (swift.versioning.s3)
Property Description

bucket

required

The name of your unique S3 bucket associated with your AWS connection.

region

required

The AWS region where your unique bucket is located. For example, Asia Pacific (Sydney). See AWS Local Zones locations for more details.

rootFolder

required

This path points to the folder you want to use within your bucket.

endpoint

optional

The URL used to send your API requests. See AWS service endpoints for more details on AWS web service entry points.

pathstyle

optional

This boolean defines whether a path-style URL or a custom-style endpoint is used.

When set to true, path-style requests must be used.

Path-style requests will be deprecated; see Amazon S3 Path Deprecation Plan – The Rest of the Story for more details.


When set to false, the access style is determined by your endpoint configuration. For example, the bucket name is included in the domain in virtual-hosted–style requests.

connection-acquire-timeout

optional default is 10

Timeout in seconds for acquiring an S3 connection from the pool. See AWS SDK for Java API Reference for more details.

max-connections

optional default is 50

Maximum number of S3 connections in the pool. See AWS SDK for Java API Reference for more details.

max-connection-acquires

optional default is 10000

Maximum number of pending requests when the pool is empty. Additional requests are queued pending a free connection in the pool if all connections are in use. See AWS SDK for Java API Reference for more details.

rate-limit-period

optional default is 100

Time period in milliseconds during which only a certain amount of calls, defined by the rate-limit, are permitted.

rate-limit

optional default is 5

Limit for the maximum number of calls permitted during a given time (the rate-limit-period).

rate-limit-timeout:

optional default is 60000

Duration in milliseconds, after which a call times out if the current rate limit doesn’t allow its execution.

AWS connection

The magnolia-aws-foundation module handles all Amazon connections from Magnolia. It’s installed automatically by Maven when you install any AWS-dependent module.

To use AWS in Magnolia, you must have a working AWS account.

You need AWS credentials to connect AWS to Magnolia. Credentials consist of:

  • AWS access key ID

  • AWS secret access key

  • Optionally, a session token (when using the AWS default credential provider chain)

Generate the key in the security credentials section of the Amazon IAM Management Console. In the navigation bar on the upper right, choose your user name, and then choose My Security Credentials.

Using the AWS default credential provider chain

The AWS SDK uses a chain of sources to look for credentials in a specific order. For more information, see Default credentials provider chain.

  1. Set your AWS credentials by following the instructions in the AWS documentation: Provide temporary credentials to the SDK.

    For a more secure implementation using the default credential provider chain, we recommend using a session token, which expires, rather than a permanent user token.

  2. Disable Magnolia’s internal credential handling by doing one of the following:

    1. Adding the following configuration properties to your WEB-INF/config/default/magnolia.properties file:

      magnolia.aws.validateCredentials=false
magnolia.aws.useCredentials=false

    2. Using JVM arguments as shown in the next step.

  3. Set your AWS session or user token. AWS credentials can be injected using environment variables or JVM system properties. For more details, see Default credentials provider chain and Configure access to temporary credentials.

    Example configuration with a session token and JVM arguments
    -Dmagnolia.aws.validateCredentials=false(1)
-Dmagnolia.aws.useCredentials=false(1)
-Daws.accessKeyId=$AWS_ACCESS_KEY_ID(2)
-Daws.secretAccessKey=$AWS_SECRET_ACCESS_KEY(2)
-Daws.sessionToken=$AWS_SESSION_TOKEN(2)(3)
    1 Disables Magnolia’s internal credential handling using JVM properties.
    2 JVM properties to inject environment variables containing the AWS credentials. Ensure that your environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN are set.
    3 AWS_SESSION_TOKEN is optional.
    Example configuration with a permanent user token
    -Dmagnolia.aws.validateCredentials=false
-Dmagnolia.aws.useCredentials=false
-Daws.accessKeyId=<your-access-key-id>
-Daws.secretAccessKey=<your-secret-access-key>
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules