GitHub Data Source

The GitHub Data Source lets you index content from your GitHub repositories into a SearchBlox collection, allowing you to search code, issues, pull requests, wikis, and discussions directly within SearchBlox.

Configuring SearchBlox

Before using the GitHub Data Source, make sure SearchBlox is installed and a Custom Collection is created.

Configuration details of GitHub Data Source

Accessing Connector UI

🚧

Note:

In Linux, make sure that necessary permissions have been provided to the folder /opt by using the CHMOD command for writing log files and executing jar files.

usernameGitHub User Name.
passwordGitHub Password.
data-directoryFolder where data will be stored. Make sure it has write permission.
api-keySearchBlox API Key
colnameName of the Custom Collection in SearchBlox.
urlSearchBlox URL
githuburlGitHub URL
example: https://api.github.com
public-reposSet true to index public repositories, false otherwise. Default is true.
exclude-repoGitHub repositories to exclude.
include-usersGitHub user repositories to include.
include-orgsGitHub organization repositories to include.
exclude-filesFiles in GitHub not to be indexed.
exclude-formatsFile formats to exclude in GitHub.
exclude-foldersFolders in GitHub to exclude.
max-folder-sizeMaximum size of a static folder in MB before it is swept.
servlet url & delete-api-url:Make sure the port number is correct. For example, use 8080 if SearchBlox runs on port 8080.

Please give relevant details based on your requirement.