> ## Documentation Index
> Fetch the complete documentation index at: https://backstage.spotify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Ingesting Entities into your Catalog from GitHub

> Configure GitHub Discovery in Portal to automatically find and ingest catalog entities from your GitHub organization repositories.

In order to set up GitHub discovery, you will first need to ensure you have configured a GitHub integration using either a GitHub App or Personal Access Token. You will also need admin access to your Portal instance. Once you have confirmed both of these things, you can follow these steps to configure the provider.

1. In the sidebar, click **Catalog Settings** and select **GitHub Discovery** from the list of providers

   <Frame>
     <img
       src="https://mintcdn.com/spotify-89f50c35/Q90PKbIHpfrGfn3j/portal/assets/github-discovery-config-manager.png?fit=max&auto=format&n=Q90PKbIHpfrGfn3j&q=85&s=de9eea0fdec3e141e17c5bc503c8613f"
       alt="The Catalog Settings Providers
   page"
       width="2382"
       height="1083"
       data-path="portal/assets/github-discovery-config-manager.png"
     />
   </Frame>

2. Fill out at least the following required fields

   * `organization`: The name of your GitHub organization
   * `schedule`
     * `frequency`: How often the provider should run. If you're not sure what to set this to, a default value of 3 hours is suggested
     * `timeout`: The maximum amount of time the operation should take before timing out. If you're not sure what to set this to, a default value of 1 hour is suggested
       <Frame>
         <img
           src="https://mintcdn.com/spotify-89f50c35/wmfB3eUmQTfpJTO0/portal/assets/events-based-github-provider.png?fit=max&auto=format&n=wmfB3eUmQTfpJTO0&q=85&s=5a8d3f09db6fecdd246bad014bd13ca2"
           alt="The Catalog Settings Providers GitHub configuration
       page"
           width="2371"
           height="850"
           data-path="portal/assets/events-based-github-provider.png"
         />
       </Frame>

   <Frame>
     <img
       src="https://mintcdn.com/spotify-89f50c35/wmfB3eUmQTfpJTO0/portal/assets/events-based-github-frequency.png?fit=max&auto=format&n=wmfB3eUmQTfpJTO0&q=85&s=fce7d14cf421d7d70b6257b33ad23c6d"
       alt="The Catalog Settings Providers GitHub page showing schedule frequency
   fields"
       width="2176"
       height="1122"
       data-path="portal/assets/events-based-github-frequency.png"
     />
   </Frame>

3. Click **Save** in the top right of the page and wait until the page has reloaded before navigating away