# **Configuring SearchBlox**

Before using the GitHub Data Source, SearchBlox has to be installed and set up successfully. Then create a **Custom Collection**.


# **Configuration details of GitHub Data Source**

[Accessing Connector UI](🔗)


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.

Column Title
Column Title
usernameUser Name in GitHub
passwordPassword in GitHub
data-directoryData Folder where the data needs to be stored. Make sure it has write permission.
api-keySearchBlox API Key
colnameThe name of the custom collection in SearchBlox.
urlSearchBlox URL
githuburlGitHub URL example: https://api.github.com
public-reposIf public repos are to be indexed give the value as **true **otherwise **false**. By default the value would be **true** , otherwise all repos in public would start to get indexed.
exclude-reporepos to exclude.
include-usersUser repos to include.
include-orgsOrganization repos to include.
exclude-filesFiles not to be indexed from GitHub.
exclude-formatsFile formats to exclude in GitHub.
exclude-foldersFolders to exclude in GitHub.
max-folder-sizeMaximum size of static folder after which it should be sweeped in MB.
servlet url & delete-api-url:Make sure that the port number is right. If your SearchBlox runs in 8080 port the URLs should be right.

Please give relevant details based on your requirement.