GitHub

GitHub provides hosting for software development version control using Git, including distributed version control and source code management (SCM) functionality.

Creating an API Token for GitHub

Before configuring the GitHub connector in Lucidum, you must first create an API Key. Lucidum will use the API key to access the GitHub API.

1. From GitHub, Go to Settings -> Developer Settings -> Personal access token.

2. Generate a new token and then give the following read-only permissions:

   • read:packages

   • read:org

   • read:public_key

   • read:user

   • user:email

   • read:enterprise

3. To use a personal access token with an organization that uses SAML single sign-on (SSO), you must first authorize the token. For details, https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.

4. To get the GitHub user email, the users must set their email addresses as “public”. In the user profile, select a primary email address to be “public”. If you do not set a public email address, then it will have a value of null.

Configuring the Connector for GitHub

To configure Lucidum to ingest data from GitHub:

1. Log in to Lucidum.

2. In the left pane, click Connector.

3. In the Connector page, click Add Connector.

4. Scroll until you find the Connector you want to configure. Click Connect. The Settings page appears.

5. In the Settings page, enter the following:

   • URL (required): The URL of the GitHub API.

   • Organization (required) - The organization for the GitHub account, for example, LucidumInc

   • API Token (required) - Specify the personal access token that has read access.

   • Verify SSL. For future use.

6. To test the configuration, click Test.

   • If the connector is configured correctly, Lucidum displays a list of services that are accessible with the connector.

   • If the connector is not configured correctly, Lucidum displays an error message.