> ## Documentation Index > Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt > Use this file to discover all available pages before exploring further. # GitHub V1 > The GitHub connector retrieves data from GitHub repositories using the GitHub REST API. export const schema = { "type": "object", "title": "A GitHub Connector", "description": "GitHub", "required": ["id", "connector", "type", "pipeline", "properties"], "properties": { "category": { "type": "string", "title": "Category", "default": "Repository", "hints": ["hidden", "readonly"] }, "id": { "type": "string", "title": "Datasource ID", "description": "Unique name for this datasource.", "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$" }, "connector": { "type": "string", "title": "Connector Type", "description": "Connector Type.", "hints": ["hidden"], "minLength": 1 }, "type": { "type": "string", "title": "Datasource Type", "description": "Datasource type supported by the selected connector type.", "hints": ["hidden"], "minLength": 1 }, "pipeline": { "type": "string", "title": "Pipeline ID", "description": "Name of an existing index pipeline for processing documents.", "minLength": 1 }, "description": { "type": "string", "title": "Description", "description": "Optional description for this datasource." }, "type_description": { "type": "string", "title": "Type Description", "default": "GitHub", "hints": ["hidden", "readonly"] }, "properties": { "type": "object", "title": "Properties", "description": "Datasource configuration properties", "required": ["startLinks"], "properties": { "fetchThreads": { "type": "integer", "title": "Fetch threads", "description": "The number of threads to use during fetching. The value is 1 when 'enterprise:false', if 'enterprise:true' the threads can be incremented", "default": 1 }, "startLinks": { "type": "array", "title": "Start Links", "description": "The link to the GitHub repository to be crawled, e.g., https://github.com/lucidworks/fusion-cloud-native", "items": { "type": "string", "minLength": 1 } }, "collection": { "type": "string", "title": "Collection", "description": "Collection documents will be indexed to.", "hints": ["hidden"], "pattern": "^[a-zA-Z0-9_-]+$" }, "db": { "type": "object", "title": "Connector DB", "description": "Type and properties for a ConnectorDB implementation to use with this datasource.", "required": ["type"], "properties": { "type": { "type": "string", "title": "Implementation Class Name", "description": "Fully qualified class name of ConnectorDb implementation.", "default": "com.lucidworks.connectors.db.impl.MapDbConnectorDb", "minLength": 1 }, "inlinks": { "type": "boolean", "title": "Process Inlinks?", "description": "Keep track of incoming links. This negatively impacts performance and size of DB.", "default": false }, "aliases": { "type": "boolean", "title": "Process Aliases?", "description": "Keep track of original URI-s that resolved to the current URI. This negatively impacts performance and size of DB.", "default": false }, "inv_aliases": { "type": "boolean", "title": "Process Inverted Aliases?", "description": "Keep track of target URI-s that the current URI resolves to. This negatively impacts performance and size of DB.", "default": false } }, "hints": ["hidden"] }, "dedupe": { "type": "boolean", "title": "Dedupe documents", "description": "If true, documents will be deduplicated. Deduplication can be done based on an analysis of the content, on the content of a specific field, or by a JavaScript function. If neither a field nor a script are defined, content analysis will be used.", "default": false, "hints": ["advanced"] }, "dedupeField": { "type": "string", "title": "Dedupe field", "description": "Field to be used for dedupe. Define either a field or a dedupe script, otherwise the full raw content of each document will be used.", "hints": ["advanced"] }, "dedupeScript": { "type": "string", "title": "Dedupe script", "description": "Custom javascript to dedupe documents. The script must define a 'genSignature(content){}' function, but can use any combination of document fields. The function must return a string.", "hints": ["advanced", "code", "code/javascript"] }, "dedupeSaveSignature": { "type": "boolean", "title": "Save dedupe signature", "description": "If true,the signature used for dedupe will be stored in a 'dedupeSignature_s' field. Note this may cause errors about 'immense terms' in that field.", "default": false, "hints": ["advanced"] }, "delete": { "type": "boolean", "title": "Delete dead URIs", "description": "Set to true to remove documents from the index when they can no longer be accessed as unique documents.", "default": true }, "deleteErrorsAfter": { "type": "integer", "title": "Fetch failure allowance", "description": "Number of fetch failures to tolerate before removing a document from the index. The default of -1 means no fetch failures will be removed.", "default": -1 }, "emitThreads": { "type": "integer", "title": "Emit threads", "description": "The number of threads used to send documents from the connector to the index pipeline. The default is 5.", "default": 5 }, "chunkSize": { "type": "integer", "title": "Fetch batch size", "description": "The number of items to batch for each round of fetching. A higher value can make crawling faster, but memory usage is also increased. The default is 1.", "default": 1, "hints": ["advanced"] }, "fetchDelayMS": { "type": "integer", "title": "Fetch delay", "description": "Number of milliseconds to wait between fetch requests. The default is 0. This property can be used to throttle a crawl if necessary.", "default": 0, "hints": ["advanced"] }, "refreshAll": { "type": "boolean", "title": "Recrawl all items", "description": "Set to true to always recrawl all items found in the crawldb.", "default": true, "hints": ["advanced"] }, "refreshStartLinks": { "type": "boolean", "title": "Recrawl start links", "description": "Set to true to recrawl items specified in the list of start links.", "default": false, "hints": ["advanced"] }, "refreshErrors": { "type": "boolean", "title": "Recrawl errors", "description": "Set to true to recrawl items that failed during the last crawl.", "default": false, "hints": ["advanced"] }, "refreshOlderThan": { "type": "integer", "title": "Recrawl age", "description": "Number of seconds to recrawl items whose last fetched date is longer ago than this value.", "default": -1, "hints": ["advanced"] }, "refreshIDPrefixes": { "type": "array", "title": "Recrawl ID prefixes", "description": "A prefix to recrawl all items whose IDs begin with this value.", "hints": ["advanced"], "items": { "type": "string" } }, "refreshIDRegexes": { "type": "array", "title": "Recrawl ID regexes", "description": "A regular expression to recrawl all items whose IDs match this pattern.", "hints": ["advanced"], "items": { "type": "string" } }, "refreshScript": { "type": "string", "title": "Recrawl script", "description": "A JavaScript function ('shouldRefresh()') to customize the items recrawled. ", "hints": ["advanced", "code", "code/javascript"] }, "forceRefresh": { "type": "boolean", "title": "Force recrawl", "description": "Set to true to recrawl all items even if they have not changed since the last crawl.", "default": false, "hints": ["advanced"] }, "forceRefreshClearSignatures": { "type": "boolean", "title": "Clear signatures", "description": "If true, signatures will be cleared if force recrawl is enabled.", "default": true, "hints": ["advanced"] }, "retryEmit": { "type": "boolean", "title": "Retry emits", "description": "Set to true for emit batch failures to be retried on a document-by-document basis.", "default": true, "hints": ["advanced"] }, "depth": { "type": "integer", "title": "Max crawl depth", "description": "Number of levels in a directory or site tree to descend for documents.", "default": -1 }, "maxItems": { "type": "integer", "title": "Max items", "description": "Maximum number of documents to fetch. The default (-1) means no limit.", "default": -1 }, "failFastOnStartLinkFailure": { "type": "boolean", "title": "Fail crawl if start links are invalid", "description": "If true, when Fusion cannot connect to any of the provided start links, the crawl is stopped and an exception logged.", "default": true, "hints": ["advanced"] }, "crawlDBType": { "type": "string", "title": "Crawl database type", "description": "The type of crawl database to use, in-memory or on-disk.", "enum": ["in-memory", "on-disk"], "default": "on-disk", "hints": ["advanced"] }, "commitAfterItems": { "type": "integer", "title": "Commit After This Many Items", "description": "Commit the crawlDB to disk after this many items have been received. A smaller number here will result in a slower crawl because of commits to disk being more frequent; conversely, a larger number here will cause a resumed job after a crash to need to recrawl more records.", "default": 10000, "hints": ["advanced"] }, "initial_mapping": { "type": "object", "title": "Initial field mapping", "description": "Provides mapping of fields before documents are sent to an index pipeline.", "properties": { "skip": { "type": "boolean", "title": "Skip This Stage", "description": "Set to true to skip this stage.", "default": false, "hints": ["advanced"] }, "label": { "type": "string", "title": "Label", "description": "A unique label for this stage.", "hints": ["advanced"], "maxLength": 255 }, "condition": { "type": "string", "title": "Condition", "description": "Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.", "hints": ["code", "code/javascript", "advanced"] }, "reservedFieldsMappingAllowed": { "type": "boolean", "title": "Allow System Fields Mapping?", "default": false, "hints": ["advanced"] }, "retentionMappings": { "type": "array", "title": "Field Retention", "description": "Fields that should be kept or deleted", "default": [], "hints": ["advanced"], "items": { "type": "object", "required": ["field"], "properties": { "field": { "type": "string", "title": "Field", "description": "The name of the field to operate on.", "hints": ["advanced"] }, "operation": { "type": "string", "title": "Operation", "description": "The type of operation to perform: keep (default) or delete", "enum": ["keep", "delete"], "default": "keep", "hints": ["advanced"] } } } }, "updateMappings": { "type": "array", "title": "Field Value Updates", "description": "Values that should be added to or set on a field. When a value is added, any values previously on the field will be retained. When a value is set, any values previously on the field will be overwritten.", "default": [], "hints": ["advanced"], "items": { "type": "object", "required": ["field", "value"], "properties": { "field": { "type": "string", "title": "Field", "description": "The name of the field to operate on.", "hints": ["advanced"] }, "value": { "type": "string", "title": "Value", "description": "The value to add to or set on the field.", "hints": ["advanced"] }, "operation": { "type": "string", "title": "Operation", "description": "The type of operation to perform: add (default) or set.", "enum": ["add", "set"], "default": "add", "hints": ["advanced"] } } } }, "translationMappings": { "type": "array", "title": "Field Translations", "description": "Fields that should be moved or copied to another field. When a field is moved, the values from the source field are moved over to the target field and the source field is removed. When a field is copied, the values from the source field are copied over to the target field and the source field is retained.", "default": [{ "source": "charSet", "target": "charSet_s", "operation": "move" }, { "source": "fetchedDate", "target": "fetchedDate_dt", "operation": "move" }, { "source": "lastModified", "target": "lastModified_dt", "operation": "move" }, { "source": "signature", "target": "dedupeSignature_s", "operation": "move" }, { "source": "length", "target": "length_l", "operation": "move" }, { "source": "mimeType", "target": "mimeType_s", "operation": "move" }, { "source": "parent", "target": "parent_s", "operation": "move" }, { "source": "owner", "target": "owner_s", "operation": "move" }, { "source": "group", "target": "group_s", "operation": "move" }], "hints": ["advanced"], "items": { "type": "object", "required": ["source", "target"], "properties": { "source": { "type": "string", "title": "Source Field", "description": "The name of the field to operate on.", "hints": ["advanced"] }, "target": { "type": "string", "title": "Target Field", "description": "The name of the target field.", "hints": ["advanced"] }, "operation": { "type": "string", "title": "Operation", "description": "The type of operation to perform: copy (default) or move.", "enum": ["copy", "move"], "default": "copy", "hints": ["advanced"] } } } }, "unmappedRule": { "type": "object", "title": "Unmapped Fields", "description": "Fields not mapped by the above rules. By default, any remaining fields will be kept on the document.", "properties": { "keep": { "type": "boolean", "title": "Keep", "description": "Keep all unmapped fields", "default": true, "hints": ["advanced"] }, "delete": { "type": "boolean", "title": "Delete", "description": "Delete all unmapped fields", "default": false, "hints": ["advanced"] }, "fieldToMoveValuesTo": { "type": "string", "title": "Move", "description": "Move all unmapped field values to this field", "hints": ["advanced"] }, "fieldToCopyValuesTo": { "type": "string", "title": "Copy", "description": "Copy all unmapped field values to this field", "hints": ["advanced"] }, "valueToAddToUnmappedFields": { "type": "string", "title": "Add", "description": "Add this value to all unmapped fields", "hints": ["advanced"] }, "valueToSetOnUnmappedFields": { "type": "string", "title": "Set", "description": "Set this value on all unmapped fields", "hints": ["advanced"] } }, "default": { "keep": true, "delete": false, "fieldToMoveValuesTo": "", "fieldToCopyValuesTo": "", "valueToAddToUnmappedFields": "", "valueToSetOnUnmappedFields": "" } } }, "category": "Field Transformation", "categoryPriority": 7, "hints": ["advanced"], "unsafe": false }, "excludeExtensions": { "type": "array", "title": "Excluded file extensions", "description": "File extensions that should not to be fetched. This will limit this datasource to all extensions except this list.", "items": { "type": "string" } }, "excludeRegexes": { "type": "array", "title": "Exclusive regexes", "description": "Regular expressions for URI patterns to exclude. This will limit this datasource to only URIs that do not match the regular expression.", "items": { "type": "string" } }, "includeExtensions": { "type": "array", "title": "Included file extensions", "description": "File extensions to be fetched. This will limit this datasource to only these file extensions.", "items": { "type": "string" } }, "includeRegexes": { "type": "array", "title": "Inclusive regexes", "description": "Regular expressions for URI patterns to include. This will limit this datasource to only URIs that match the regular expression.", "items": { "type": "string" } }, "f.github_base_url": { "type": "string", "title": "GitHub Base URL", "default": "https://github.com" }, "f.github_enterprise": { "type": "boolean", "title": "GitHub Enterprise", "default": false }, "f.github_username": { "type": "string", "title": "GitHub username", "hints": ["hidden"] }, "f.github_password": { "type": "string", "title": "GitHub password", "hints": ["secret", "hidden"] }, "f.github_oauth_token": { "type": "string", "title": "GitHub oAuth Token", "hints": ["secret"] }, "f.github_accept_self_signed_ssl_certificate": { "type": "boolean", "title": "Accept self signed SSL certificate", "default": true }, "f.branches": { "type": "boolean", "title": "Branches", "default": false }, "f.commits": { "type": "boolean", "title": "Commits", "default": true }, "f.commit_diffs": { "type": "boolean", "title": "Commit diffs", "default": false }, "f.commit_comments": { "type": "boolean", "title": "Commit comments", "default": false }, "f.blobs": { "type": "boolean", "title": "Content (blobs)", "default": false }, "f.pull_requests": { "type": "boolean", "title": "Pull requests", "default": true }, "f.pull_request_comments": { "type": "boolean", "title": "Pull request comments", "default": false }, "f.issues": { "type": "boolean", "title": "Issues", "default": true }, "f.issue_comments": { "type": "boolean", "title": "Issue comments", "default": false }, "f.tags": { "type": "boolean", "title": "Tags", "default": false }, "f.milestones": { "type": "boolean", "title": "Milestones", "default": false }, "f.releases": { "type": "boolean", "title": "Releases", "default": false }, "f.collaborators": { "type": "boolean", "title": "Collaborators", "default": false }, "rewriteLinkScript": { "type": "string", "title": "URI rewrite script", "description": "A Javascript function 'rewriteLink(link) { }' to modify links to documents before they are fetched.", "hints": ["advanced", "code", "code/javascript"] }, "diagnosticMode": { "type": "boolean", "title": "Diagnostic mode", "description": "Enable to print more detailed information to the logs about each request.", "default": false, "hints": ["advanced"] } }, "propertyGroups": [{ "label": "Crawl History", "properties": ["crawlDBType", "commitAfterItems"] }, { "label": "Dedupe", "properties": ["dedupe", "dedupeSaveSignature", "dedupeField", "dedupeScript"] }, { "label": "Limit Documents", "properties": ["depth", "maxItems", "includeExtensions", "includeRegexes", "excludeExtensions", "excludeRegexes", "delete", "deleteErrorsAfter"] }, { "label": "Recrawl Rules", "properties": ["refreshAll", "refreshStartLinks", "refreshErrors", "refreshOlderThan", "refreshIDPrefixes", "refreshIDRegexes", "refreshScript", "forceRefresh", "forceRefreshClearSignatures"] }, { "label": "Crawl Performance", "properties": ["chunkSize", "fetchThreads", "fetchDelayMS", "emitThreads", "retryEmit", "failFastOnStartLinkFailure"] }, { "label": "Field Mapping", "properties": ["initial_mapping"] }] } }, "category": "Other", "categoryPriority": 1, "unsafe": false }; export const SchemaParamFields = ({schema}) => { const sanitize = str => { if (typeof str !== "string") return str; return str.replace(/^"(.*)"$/s, "$1").replace(/\\/g, "").replace(/"/g, "'"); }; const formatDescription = str => { const s = sanitize(str); return (/[.!?]\)*$/).test(s) ? s : `${s}.`; }; const {description, properties = {}, required: requiredProps = []} = schema; const visibleProps = useMemo(() => Object.entries(properties).filter(([, prop]) => !prop.hints?.includes("hidden")), [properties]); return
{description &&

{formatDescription(description)}

} {visibleProps.map(([name, prop]) => { const isRequired = requiredProps.includes(name); const hasDefault = prop.default !== undefined; const rawDefault = prop.default; const isComplexDefault = hasDefault && (typeof rawDefault === "object" || typeof rawDefault === "string" && (rawDefault.length > 20 || rawDefault.includes('"'))); const fieldProps = { key: name, body: prop.title || name, type: prop.type, ...prop.title && ({ post: [<>API property: {name}] }), ...isRequired && ({ required: true }), ...!isComplexDefault && hasDefault ? { default: sanitize(String(rawDefault)) } : {} }; const isObject = prop.type === "object" && prop.properties; const isArrayOfObjects = prop.type === "array" && prop.items?.type === "object" && prop.items.properties; return {prop.description &&

{formatDescription(prop.description)}

} {isComplexDefault &&

Default: 

                  
                    {JSON.stringify(rawDefault, null, 2)}
} {isArrayOfObjects &&

Object attributes: 

                
                  {'{\n'}
                  {Object.entries(prop.items.properties).map(([iname, iprop]) => <>
                      {`  ${iname}`}
                      {prop.items?.required?.includes(iname) &&  required}
                      {`: {\n    display name: ${sanitize(iprop.title || '')}\n    type: ${iprop.type}\n  }\n`}
                    )}
                  {'}'}
} {isObject && } ; })}
; }; export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => { const [isLoaded, setIsLoaded] = useState(false); useEffect(() => { const timer = setTimeout(() => { setIsLoaded(true); }, 500); return () => clearTimeout(timer); }, []); return
{isLoaded && ` }} />} Powered by Lucidworks Agent Studio
; }; [localhost link]: http://localhost:3000/docs/fusion-connectors/connectors/v1/github [mintlify link]: https://doc.lucidworks.com/docs/fusion-connectors/connectors/v1/github [old doc.lw link]: https://doc.lucidworks.com/fusion-connectors/64 **Compatible with Fusion version:** 4.0.0 through 5.12.0 V1 deprecation and removal notice Starting in Fusion 5.12.0, all V1 connectors are deprecated. This means they are no longer being actively developed and will be removed in Fusion 5.13.0. The replacement for this connector is in active development at this time and will be released at a future date. If you are using this connector, you must migrate to the replacement connector or a supported alternative before upgrading to Fusion 5.13.0. We recommend migrating to the replacement connector as soon as possible to avoid any disruption to your workflows. GitHub repository access needs authentication, in which case GitHub oAuth token Authentication will be used to perform GitHub requests. See the [GitHub oAuth Authentication](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token) page for more information. The GitHub API service implements [rate limiting](https://developer.github.com/v3/#rate-limiting). If you repeatedly crawl the commits in a large or old repository, this can trigger a temporary lockout. For this reason, Lucidworks recommends creating a separate GitHub user specifically for Fusion’s GitHub connector. ## Configuration When entering configuration values in the UI, use *unescaped* characters, such as `\t` for the tab character. When entering configuration values in the API, use *escaped* characters, such as `\\t` for the tab character.