Edit online

How to Configure Connection to Oxygen Text Search Service

The connection to the Oxygen Text Search Service can be configured in the $OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-home/config/feedback-text-search.properties file:
###################################################################
# Stores the configuration properties for the Text Search support #
###################################################################

# Flag used to enable the Text Search support.
feedback.text.search.enabled=true

# Specifies the Oxygen Text Search server URL 
feedback.text.search.serverUrl=http://oxygen-text-search-service:8888/

# The list of elements (by tag or class name) to be excluded from indexing.
feedback.text.search.indexingIgnoredElements=div.ignore,nav.wh_tools,footer,header.wh_header,div.wh_publication_toc,div.wh_topic_toc,div.wh_child_links,div.related_link,div.wh_copyright_information,a.sr-only-focusable,span.search_input_text
This file can be used to configure the following:
  • Whether the Oxygen Text Search Service connection is enabled or disabled.
  • The URL of the Oxygen Text Search Service instance.
    Note: The Oxygen Feedback and Oxygen Text Search Service containers are configured in the same Docker Compose file, which means they will join the same Docker network at start-up. Each container is both reachable by other containers on that network, and discoverable by them at a host name identical to the container name.
    Note: If the Oxygen Feedback instance is configured to use an HTTP Proxy, the host name of the Oxygen Text Search Service instance should be configured to be reached directly, bypassing the proxy. See also: How to Configure an HTTP Proxy.
  • The list of elements (by tag or class name) to be excluded from indexing.