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

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

Tool URL

The tool URL is the protocol and domain editors use to access Brightspot. You configure the tool URL in the context.xml file.

<Environment name="brightspot/toolUrlPrefix" type="java.lang.String" value="{protocol:domain}" />
Key: brightspot/toolUrlPrefix Type: java.lang.String
Set {protocol:domain} to the protocol and domain editors use to access Brightspot. This setting behaves similarly to a redirect directive on a web server.

Example

<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 attempting to access Brightspot at the domain http://www.example.com/cms/ 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 default application path for the Brightspot editorial UI is /cms, as in localhost:8080/cms. You can customize the application path with the following steps.

Step 1: Configure Application Path in the content.xml File

<Environment name="dari/routingFilter/applicationPath/cms" type="java.lang.String" value="{app_path}" override="false" />
Key: dari/routingFilter/applicationPath/cms Type: java.lang.String
Set {app_path} to any valid path usable in a URL.

Example

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

Step 2: Update the pom.xml File for the Site Module

  1. In brightspot/express/site/pom.xml, search for the maven-war-plugin artifactId.
  1. Add an overlay configuration to the artifactId. In the targetPath element, specify the application path that you set in context.xml. In the following example, targetPath is set to the same value as {app_path} 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

A new WAR file is built in brightspot/express/site/target.

Given the example configuration changes, editors log into Brightspot at http://www.domain.com/admin/login.jsp.