Data providers and other community stakeholders must currently invest operational and development resources producing search clients to serve a segment of the community. Earthdata Search portals reduce the overhead of providing a search interface similar to Earthdata Search to targeted users. It provides several useful features, including:

• Running a maintained, up-to-date instance of Earthdata Search without incurring the cost of hardware or administration
• The ability to present a limited set of collections to users, scoped to only those relevant to the target user community
• Presentation of additional logos, navigation, and page titles
• A simple URL parameter https://search.sit.earthdata.nasa.gov/search?portal=your-portal-name
     this is backwards compatible with the previously established bookmark-able links e.g. (https://search.earthdata.nasa.gov/portal/your-portal-name)
• Interoperability with the full Earthdata Search site, allowing users to optionally and easily search the full list of collections, and see their saved projects and past retrievals from the portal in Earthdata Search
• Inclusion of custom provider-developed configuration allowing for the manipulation of basic Earthdata Search user interface elements such as showing the only-granules and non-eosdis additional filter checkboxes

The remainder of this document will walk through the process of creating and configuring a portal.

Step 1: Reach out!

We're here to help, and we want to understand community needs so we can refine our features. Email Valerie Dixon (valerie.dixon@nasa.gov) to get started with your portal and get in touch with developers.

Step 2:  Fork our GitHub repository

Important: The workflow for configuring portals is geared toward teams who have familiarity with basic development tools such as git. If this is not the case for you, please reach out to us and let us know; we may be able to assist you with basic configuration.

Because portal configurations are powerful enough to modify Earthdata Search's functionality in arbitrary ways, we must handle portal configuration through our Github project (https://github.com/nasa/earthdata-search/).  This allows us to understand incoming changes, test existing portals against new features, and prevent insecure or malicious code from entering our operational environment.

To provide us configuration most efficiently, you will need to fork our GitHub repository.

Step 3:  Startup a Local instance of Earthdata Search

Clone the code from your fork and follow the README to get a local instance of Earthdata Search set up.

Step 4: Configure your portal

To create your portal you will need to create a new directory in "/portals" with a unique name you want as your portal identifier, for this example we will use "example". You then will create the config.json file ("/portals/example/config.json"). 

A significant amount of configuration can be done through this config.json file. You can view an example configuration at https://github.com/nasa/earthdata-search/blob/main/portals/default/config.json or browse https://github.com/nasa/earthdata-search/tree/main/portals to see all portal configurations. Here is an explanation of the configuration:

features

    advancedSearch

    authentication

    featureFacets

        showAvailableFromAwsCloud

        showCustomizable

        showMapImagery

footer

    attributionText

    displayVersion

    primaryLinks

{
    href: "The URL the link will follow",
    title: "The viewable text of the link" 
}

    secondaryLinks

moreInfoUrl

pageTitle

parentConfig

portalBrowser

query

  "query": {
    "dataCenter": "ORNL_DAAC",
    "hasGranulesOrCwic": null
  },

  "query": {
    "project": "AirMOSS",
    "hasGranulesOrCwic": null
  },

  "query": {
    "tagKey": ["gov.nasa.impact.*"],
    "hasGranulesOrCwic": null
  },

title

    primary

    secondary

ui

    showNonEosdisCheckbox

    showOnlyGranulesCheckbox

    showTophat

Inheriting Configuration Values

Portals inherit configuration values from a parent configuration. See the "parentConfig" value above. This allows you to use all of a parent's config values and keep your portal configuration minimal if your portal needs most of the same features as the parent configuration.

Adding Portal Logo

To add a new logo image, which are displayed in the left toolbar to establish the search context or on the  the portal browser modal (optionally. see portalBrowser boolean config field).

Save your image into the ./portals/myportal/images/ directory and name this file logo.png

Custom Logo Best Practices:

• Images will be displayed at a maximum of 75px tall by 75px wide. Logos should be trimmed to fit within those dimensions.
• It is highly encouraged that images be provided at twice their displayed size (50px x 114px maximum) for better display on high resolution screens.
• Images must be named logo.png

Adding Portal to the index.js list

In the /portals directories you will need to add the name of your portal to the portals list in the index.js file. The string you enter should be the same as the name of the directory for your portal. Portals should be added in alphabetical order.
    

portals [
  'above',
    ...
  'your-portal-example'
]

Step 5:  Incorporating Changes into Earthdata Search

When you have made and tested your changes, push them to your forked copy of the Earthdata Search repository and issue a pull request into the main repository using the pull request template. Our developers will review and incorporate the changes as soon as possible.

Our normal progression to operations is as follows:

1. When a pull request is merged, it starts a build. Within a few minutes of the build becoming green, those changes get pushed to our SIT environment for testing: https://search.sit.earthdata.nasa.gov
2. Every other Wednesday, our current UAT environment (https://search.uat.earthdata.nasa.gov) is deployed to our operational environment (https://search.earthdata.nasa.gov) and our SIT environment from the previous Monday is deployed to our UAT environment.

So the progression from a pull request being accepted to it becoming an operational change takes about a month, during which it is available in testing environments.

While we would prefer to stick to this schedule wherever possible, we understand you may have differing schedule needs. If you need it to reach operations sooner, please indicate the desired date on the pull request and we will do our best to accommodate.