search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso

GitHub Content Source Connector Guide

Ingest all of your GitHub pull requests and issues into Enterprise Search.

The GitHub Connector requires that you create an OAuth App within GitHub.

Adding GitHub requires that you belong to - and have OAuth permissions within - a GitHub organization.

Configuration

Login to GitHub: https://github.com.

Click your portrait in the top right and then navigate to Settings:

GitHub - Login, click your portrait, then select Settings.
A cursor is clicking on a logo donning a contemplative dreadlocked figure in the top right corner of GitHub's main dashboard menu. A dropdown menu is invoked containing many options, and settings is highlighted.

You'll see a set of menu items on the left under personal settings.

At the bottom, click Developer Settings:

GitHub - Select Developer Settings from within the main settings menu.
The left-hand GitHub menu. Developer settings is way at the bottom.

Enterprise Search needs an OAuth App with which to speak.

There are two important things to understand before you create one...

  1. The app can stay in developer mode. You do not need to publish it.
  2. Make sure that you create this app with a trusted and stable GitHub account!

We recommend creating a team-owned account for only this app. If access is lost, we cannot help.

Alright, now that we've gotten the business out of the way, click New OAuth App:

GitHub - Click New OAuth App.
A menu shows a couple silly applications. One is for a personal blog, the other is for some sort of wizardly magic. The author should probably have cleared this view out, but you know, a little character never hurts. But the important thing is that the button that reads New OAuth App is highlighted with a pink box.

You'll need to fill in specific values:

  • Application Name: A name to help you identify the application. It's best to make it explicit: Enterprise Search, or something like that.
  • Description (Optional): More information will help you remember the application's purpose.
  • Homepage URL: Must match the address which you've used to host Enterprise Search. Default: http://127.0.0.1:3002.
  • Authorization callback URL: A callback URL lets the application how to reach the right Enterprise Search endpoint. Default: http://localhost:3002/ent/.

Fill in the values, then click Register Application:

GitHub - Fill out the OAuth Application menu using the above values.
A form with the appropriate values filled in -- keep reading to learn said values. The Register Application button is highlighted with a pink box.

The application has been registered. Great!

You will now be able to retrieve your Client ID and Client Secret.

Keep them secret!

GitHub - Retrieve your Client ID and Client Secret
The application has been created. The client ID and client secret are highlighted with a pink box.

You can also add a logo for visual identification.

Click Upload new logo.

Here's the Elastic Enterprise Search logo, if you'd like to use that one.

Right click and save-as:

It's all colourful, sleek, and sophisticated. A partial, sunlike circle with a convex-like bubble coming out of the right side connects to what looks like a convex green eye. It's pretty radical.

For the final step, you must return back to Enterprise Search.

Login to Enterprise Search.

Within the administrative dashboard, click Settings on the sidebar.

Navigate to Content Source Connectors:

GitHub - Click Settings within the sidebar, then Content Source Connectors.
A picture of the sidebar within the administrative dashboard. The item

Select the GitHub Connector and click Setup.

Fill in the Client ID and Client Secret then click Save Changes:

GitHub - Add the tokens to Enterprise Search.
Two simple text boxes, one green button. It's not our finest view, but it does the job.

Content source Connector, created!

Navigate to Settings if you ever need to change tokens or remove the Connector.

GitHub - A successful configuration.
Content source... added. Nice work.

Now, click Sources within the sidebar.

GitHub - Click Sources within the sidebar.
A picture of the sidebar within the administrative dashboard. The item

Click Add under the GitHub source.

First, you'll need to click I understand.

Why the hurdle? We want to make it clear that you're adding a public source.

All of its contents will be accessible by those with the right permissions.

If you're comfortable with that, click the button:

GitHub - Understanding the nature of public sources.
It's a button that says I understand. Seems annoying, but you'd be amazed at the things that happen.

After that, you'll be asked to connect to GitHub:

GitHub - Forward, for OAuth.
Connect the Connector!

You'll then be presented with an OAuth screen from GitHub.

Once you accept, you have added GitHub as a content source to your organization.

Congratulations! It's time to search.

You can now make the source available to various groups and scale its relevance priority.


Enjoying the beta? Something broken? Lost? Please send us your feedback or visit the Enterprise Search community.