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.
Instructions work with both GitHub and GitHub Enterprise.
Login to GitHub: https://github.com.
Click your portrait in the top right and then navigate to Settings:
You'll see a set of menu items on the left under personal settings.
At the bottom, click Developer Settings:
Enterprise Search needs an OAuth App with which to speak.
There are two important things to understand before you create one...
- The app can stay in developer mode. You do not need to publish it.
- 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:
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:
- Authorization callback URL: A callback URL lets the application how to reach the right Enterprise Search endpoint. Default:
Fill in the values, then click Register Application:
The application has been registered. Great!
You will now be able to retrieve your Client ID and Client Secret.
Keep them secret!
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:
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:
Select the GitHub Connector and click Connect.
Fill in the Client ID and Client Secret then click Save Changes.
If you're using GitHub Enterprise, add your GitHub Enterprise URL: https://github.example.com.
Content source Connector, created!
Navigate to Settings if you ever need to change tokens or remove the Connector.
Now, click Sources within the sidebar.
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:
After that, you'll be asked to connect to GitHub:
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.