Brightspot Editorial URLs

The URL editors use to access Brightspot has two components: a tool URL and an application path.

../../../_images/brightspot-editorial-url.svg

Brightspot editorial URL

Referring to the previous illustration, the tool URL is http://editor.example.com/, and the application path is cms/. This section describes how to configure both these components.

Tool URL

The key brightspot/toolUrlPrefix specifies the tool URL editors use to log in to Brightspot. This setting is useful if you installed Brightspot on one host and subsequently moved it to another; this setting redirects user requests to the new host.

The following table describes the attributes associated with this key.

Attribute Description Valid values
name Key for specifying the protocol and domain for using Brightspot. If this key is not set, Brightspot does not redirect user requests to another host. brightspot/toolUrlPrefix
type Type of the value. java.lang.String
value Protocol and domain for connecting to Brightspot. Protocol and domain name where Brightspot is installed.

The following snippet specifies the protocol and domain for the editorial URL appearing in the illustration Brightspot editorial URL.

<Environment name="brightspot/toolUrlPrefix" type="java.lang.String" value="http://editor.example.com" />

Referring to the previous snippet, editors access Brightspot at http://editor.example.com/cms/. Furthermore, editors who previously used http://www.example.com/cms/ to access Brightspot are redirected to http://editor.example.com/cms/.

You can modify the application path after the domain name by configuring dari/routingFilter/applicationPath/cms in context.xml; for details, see Application Path.

Application Path

The key dari/routingFilter/applicationPath/cms specifies the path from the server root to the Brightspot application. The following table describes the attributes associated with this key.

Attribute Description Valid values
name Key for specifying the path to Brightspot. If this key is not set, the path is cms/. dari/routingFilter/applicationPath/cms
type Type of the value. java.lang.String
value Path to Brightspot webapp. A path.

The following snippet sets the application path to admin.

Configuring application path
<Environment name="dari/routingFilter/applicationPath/cms" type="java.lang.String" value="admin" />

There are three steps to modifying the application path.

Step 1: Configure application path in the content.xml

Configure the application path as in the snippet Configuring application path.

Step 2: Update site module’s pom.xml

  1. In brightspot/express/site/pom.xml, search for the plugin <artifactId>maven-war-plugin</artifactId>.

  2. Add an overlay configuration to the plugin. In the targetPath element, specify the application path that you set in context.xml. In the following example, targetPath is set to admin as in step 1.

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <configuration>
            <overlays>
                <overlay>
                    <groupId>com.psddev</groupId>
                    <artifactId>cms-tool-ui</artifactId>
                    <targetPath>admin</targetPath>
                </overlay>
            </overlays>
        </configuration>
    </plugin>
    

Step 3: Rebuild the site module

Rebuild the site module in brightspot/express/site/:

mvn clean install -DskipTests

Deploy the new WAR file found in brightspot/express/site/target/.