🧪 BETA 🧪
This is a template repository used to generate a serverless Globus-powered research search portal.

---

View the result at: globus.github.io/template-search-portal.

While this repository is a working example of a search portal, it is also a template for creating your own research search portal.

---

Features + Functionality

Search Portal

• Powered by Globus
• Search for documents in a Globus Search Index with support for facets.
• Optional Authentication – Authenticate users to access private Globus Search Indexes.
• Globus Transfer Integration – Transfer files directly from the search portal to your Globus-connected storage.

GitHub Repository

• 📄 Hosted via GitHub Pages – Users can access your data portal at this repository's GitHub Pages URL. Use all the functionality built-in to GitHub pages to suit your needs, including configuring a custom domain.

• 🚀 Automated Deployments via GitHub Actions – Any file changes will result in the deployment (and rebuild) of your data portal.

  • You can manually trigger a deployment by navigating to the Actions tab and selecting the static workflow.

• 🤖 Dependabot – A default Dependabot configuration (.github/dependabot.yml) to keep your repository up-to-date with latest changes to globus/static-search-portal.

Examples

Example implementations of the Search Portal showing various capabilities – reviewing (and even copying) the static.json files can be a great starting point for your own portal.

• @globus/example-search-portal-with-embeds
• @globus/example-search-portal-with-transfer
• @globus/example-search-portal-with-github-action-ingest

Creating Your Own Static Research Search Portal

1. Create a new repository from the globus/template-search-portal template.
   • Using the following URL: https://github.com/new?template_name=template-search-portal&template_owner=globus
   • 
2. Update your repository to allow publishing with GitHub Actions.
   • IMPORTANT The built-in GitHub Action workflows in your new repository will fail until you've updated this setting.
3. Ensure your GitHub Pages are configured to Enforce HTTPS
4. Update the static.json to include:
   • data.attributes.globus.search.index – The Globus Search Index UUID that will be used source results from.
   • Optional: Set the data.attributes.globus.search.facets to enable facet-based filtering.
   • See the static.json type definitions for more configuration options.
5. That's it! The changes made (and any future changes) to the static.json will trigger a GitHub Action that will automatically build and deploy your research data portal to your GitHub Pages URL.

Private Globus Search Indexes (Authentication)

If your Globus Search Index is private, you'll want to include authentication to your portal.

1. Register an application on Globus – https://app.globus.org/settings/developers
   • You'll be creating an OAuth public client; This option is presented as "Register a thick client or script that will be installed and run by users on their devices".
   • Update the Redirects to include your GitHub Pages URL + /authenticate, i.e., https://{username}.github.io/{repository}/authenticate
     • If you have configured your GitHub Pages to use a custom domain, this will be https://{domain}/authenticate
     • It is important to note that Globus Auth requires HTTPS.
2. Update the static.json to include:
   • data.attributes.globus.application.client_id – The UUID of the client created in the previous step.

Common Changes after Creating Your Portal

• Result + Result Listing Rendering – Update the data.attributes.components.Result and data.attributes.components.ResultListing to reference specific properties on your indexed data.
• Edit/Remove the CITATION file – Update the CITATION.cff file to reflect the appropriate citation information for your research data portal – learn more about CITATION files.
• Removing this section of the README – Remove this section from the README.md file or update the README to meet your needs.

---

static.json

The type used for data by the @globus/static-search-portal generator.

Type declaration

See: https://github.com/globus/static-search-portal/blob/main/docs/type-aliases/Static.md

Field Types

Advanced Customization

JSONata Support