---
updatedAt: 2026-09-28T14:13:40.000Z
agentTools:
  projectIndex: https://developer.searchblox.com/v10.2/llms.txt
---

# GitHub Data Source

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

[block:image]
{
  "images": [
    {
      "image": [
        "https://files.readme.io/96af823-ALL.png",
        "ALL.png",
        512,
        184,
        "#d6d7db"
      ]
    }
  ]
}
[/block]

\#**Configuration details of GitHub Data Source**

[Accessing Connector UI](https://developer.searchblox.com/docs/connectors-ui)

[block:callout]
{
  "type": "warning",
  "body": "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.",
  "title": "Note:"
}
[/block]

[block:parameters]
{
  "data": {
    "0-0": "username",
    "0-1": "User Name in GitHub",
    "1-0": "password",
    "1-1": "Password in GitHub",
    "3-0": "api-key",
    "3-1": "SearchBlox API Key",
    "5-0": "url",
    "5-1": "SearchBlox URL",
    "6-0": "githuburl",
    "6-1": "GitHub URL\nexample: https://api.github.com",
    "12-0": "exclude-formats",
    "12-1": "File formats to exclude in GitHub.",
    "13-0": "exclude-folders",
    "13-1": "Folders to exclude in GitHub.",
    "4-0": "colname",
    "4-1": "The name of the custom collection in SearchBlox.",
    "14-0": "max-folder-size",
    "14-1": "Maximum size of static folder after which it should be sweeped in MB.",
    "15-0": "servlet url & delete-api-url:",
    "15-1": "Make sure that the port number is right. If your SearchBlox runs in 8080 port the URLs should be right.",
    "2-0": "data-directory",
    "2-1": "Data Folder where the data needs to be stored. Make sure it has write permission.",
    "7-0": "public-repos",
    "7-1": "If public repos are to be indexed give the value as **true **otherwise **false**. \nBy default the value would be **true** , otherwise all repos in public would start to get indexed.",
    "8-0": "exclude-repo",
    "8-1": "repos to exclude.",
    "9-0": "include-users",
    "9-1": "User repos to include.",
    "10-0": "include-orgs",
    "10-1": "Organization repos to include.",
    "11-0": "exclude-files",
    "11-1": "Files not to be indexed from GitHub."
  },
  "cols": 2,
  "rows": 16
}
[/block]

Please give relevant details based on your requirement.