Fork me on GitHub

Prerequisites

These instruction assume that you have a Bloomreach Experience Manager project based on the project archetype, i.e. a Maven multiproject containing submodules cms, site and repository-data.

Any document type you want to include in a feed should have at least a title field and a date field.

Installation

  1. In the main pom.xml of the project, in the repositories section, add this repository if it is not configured there yet.

    <repository>
      <id>hippo-forge</id>
      <name>Bloomreach Forge Maven 2 repository.</name>
      <url>https://maven.onehippo.com/maven2-forge/</url>
    </repository>
  2. Add a property "bloomreach.forge.feed.version" to the <properties> section in the Maven pom.xml file in the root of your project.

    <properties>
      <bloomreach.forge.feed.version>7.0.0</bloomreach.forge.feed.version>
    </properties>

    You can find the correct version of the plugin for your project in the table on the Release Notes page.

  3. Add to the pom.xml of your cms module, or better the cms-dependencies module if you have it:

    <dependency>
      <groupId>org.bloomreach.forge.feed</groupId>
      <artifactId>feed-repository</artifactId>
      <version>${bloomreach.forge.feed.version}</version>
    </dependency>

    Note: before version 5.0.0, the artifact's coordinates were org.onehippo.forge:feed-cms-addon

  4. Add to the pom.xml of yoursite module:

    <dependency>
      <groupId>org.bloomreach.forge.feed</groupId>
      <artifactId>feed-hst</artifactId>
      <version>${bloomreach.forge.feed.version}</version>
    </dependency>

    Note: before version 5.0.0, the artifact's coordinates were org.onehippo.forge:feed-hst

  5. In your site module, check in the src/main/webapp/WEB-INF/web.xml the context-parameter 'hst-annotated-bean'. It should have an entry for scanning bean classes for the forge like "classpath*:org/bloomreach/forge/**/*.class". If it is not present, add it.

    <context-param>
      <param-name>hst-beans-annotated-classes</param-name>
      <param-value>classpath*:org/example/**/*.class
          ,classpath*:org/onehippo/**/*.class
          ,classpath*:com/onehippo/**/*.class
          ,classpath*:org/bloomreach/forge/**/*.class
      </param-value>
    </context-param>
  6. In your site module also create /src/main/resources/META-INF/hst-assembly/overrides/feed-rest-services.xml that contains:

            <?xml version="1.0" encoding="UTF-8"?>
            <beans xmlns="http://www.springframework.org/schema/beans"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd">
              <import resource="classpath:/org/bloomreach/forge/feed/site/jaxrs/feed-rest-services.xml"/>
           </beans>
            
  7. When running a version 12 or later, make sure your project bootstraps after `hippo-forge` group. Typically, add it in file `repository-data/application/src/main/resources/hcm-module.yaml`:

      group:
        name: your-group-name
        after: [hippo-cms, hippo-forge]
  8. Rebuild your project using Maven.

  9. See the Usage page for further instructions.