TDS Configuration File threddsConfig.xml

The TDS configuration file (${tds.content.root.path}/thredds/threddsConfig.xml) allows the TDS administrator to set a number of parameters that control the behavior of the TDS. Most of these parameters will be set with reasonable default values. However, a number of them allow you to describe your server, provide contact information, and change the “theme” of server-generated HTML pages. So unless you want your server to be called “Initial TDS Installation”, maintained by Support at “My Group” with contact email support@my.group, then you will need to change some of these settings.

Server Information

Information describing your TDS installation and providing contact information is configured in the serverInformation element of the TDS configuration file. This includes:

  • basic information about the server (e.g., name, abstract, keywords, hostInstitution).
  • contact information so that users will know where to go with problems or questions.

Here is what the default version of the serverInformation element looks like:

<serverInformation>
  <name>Initial TDS Installation (please change threddsConfig.xml)</name>
  <logoUrl>/thredds/threddsIcon.png</logoUrl>
  <logoAltText>Initial TDS Installation</logoAltText>

  <abstract>Scientific Data</abstract>
  <keywords>meteorology, atmosphere, climate, ocean, earth science</keywords>

  <contact>
    <name>Support</name>
    <organization>My Group</organization>
    <email>support@my.group</email>
    <!--phone></phone-->
  </contact>
  <hostInstitution>
    <name>My Group</name>
    <webSite>http://www.my.site/</webSite>
    <logoUrl>/thredds/myGroup.png</logoUrl>
    <logoAltText>My Group</logoAltText>
  </hostInstitution>
</serverInformation>

Where Is Server Information Used

The headers and footers of all TDS generated catalog HTML pages. Examples:

The three supported server information documents:

Other Places Server Information Is Included

  • The Server element of the WCS GetCapabilities document.
  • All generated THREDDS catalogs that don’t override this information.

Example: Add Server Information

Change the default server information in the TDS configuration file:

  1. Look at the current server information by viewing the Server Info page in a browser.

  2. Edit the main TDS configuration catalog:

    $ cd ${tds.content.root.path}/content/thredds
$ vi threddsConfig.xml

  3. Restart Tomcat so the TDS is reinitialized:

    $ cd ${tomcat_home}/bin
$ ./shutdown.sh
$ ./startup.sh

  4. Check the server information has changed in the Server Info page:

    http://localhost:8080/thredds/serverInfo.html

Appearance Of Generated HTML Pages

Server and institution names, logos, and links given in the above section are used in all TDS generated HTML pages.

You can also specify the CSS files and several icons used in the HTML pages. These are configured in the htmlSetup element of the TDS configuration file threddsConfix.xml. Default CSS files are provided with the thredds.war distribution, and should not be modified. Instead, these can be overridden by placing the appropriate CSS files in the ${tds.content.root.path}/thredds/public/ directory.

The following shows the default configuration of the htmlSetup element:

<htmlSetup>
  <!--
   * CSS documents used in generated HTML pages.
   * The CSS document given in the "catalogCssUrl" element is used for all pages
   * that are HTML catalog views. The CSS document given in the "standardCssUrl"
   * element is used in all other generated HTML pages.
   * -->
   <standardCssUrl>standard.css</standardCssUrl>
   <catalogCssUrl>catalog.css</catalogCssUrl>
   <datasetCssUrl>dataset.css</datasetCssUrl>
   <openDapCssUrl>tdsDap.css</openDapCssUrl>
   ...
   ...
   ...
</htmlSetup>

More details are given in the TDS Configuration File Reference. The Catalog and Dataset HTML pages are generated using the Thymeleaf templating library. This means you have full control over how these pages are generated. Please see the customizing the tds look and feel for more information.

Include Generated JSON-LD In Dataset HTML Pages

This experimental feature has the overall goal of exposing TDS datasets to Google’s Dataset search.

<htmlSetup>
    ...
    ...
    ...
    <!--
     * Allow the TDS to generate JSON-LD in Dataset HTML pages following
     * schema.org Dataset (https://schema.org/Dataset)
     * The default is false, as this is experimental

    <generateDatasetJsonLD>false</generateDatasetJsonLD>
    -->
</htmlSetup>

If set to true, schema.org Dataset objects will be encoded using json-ld and embedded into the <head> element of the generated dataset HTML pages. You can add individual datasets to a sitemap.xml, located in tds.content.root.path/public (you will need to create it the first time), and it will be available at <server>/thredds/sitemap.xml. The sitemap can be submitted to Google.