Install the JFrog GitHub Copilot Extension

JFrog and GitHub Integration Guide

To install the JFrog Copilot Extension application in GitHub, follow these steps:

Prerequisites

  • Permission to install applications within your GitHub organization.

  • To install in the IDE, the Admin should have completed the installation on GitHub.

Install JFrog Copilot Extension Application:

  1. Navigate to the the JFrog Copilot Extension application in GitHub at https://github.com/marketplace/jfrog.

    JFrog for GitHub Copilot Installation

  2. Click Add at the top of the screen, or scroll down to the bottom of the screen. The Pricing and setup pane is displayed.

    Pricing and Setup Pane

  3. Click Install it for Free. The Review your Order window is displayed.

    github-review-your-order-window.png

  4. Choose the relevant organization for which, you have prepared the policies.

  5. Click Install.

    github-install-on-your-organizational-account.png

Register JFrog Platform

Note

If you do not have a JFrog platform, you can register for a free trial here: https://jfrog.com/start-free/

To register JFrog platform, follow these steps:

  1. After clicking the green Install button in the previous procedure, you'll be taken to the Acceptance dialog box. In the Acceptance dialog box:

    1. Type your JFrog platform URL in the JFrog Platform URL field.

    2. Complete the Beta Agreement.

      1. Enter your full name in the Authorized Signature Name field.

      2. Accept the terms and conditions by checking the checkbox.

    3. Click Next.

      JFrogPlatformURL.png

    The Client Settings dialog box opens.

  2. Copy the Callback URL as shown, then click on the link JFrog Platform towards the top of the dialog box.

    jfrog-github-copilot-client-settings.png

    Your JFrog Platform Deployment opens on a new application integration page.

  3. Type a name you want to use for the integration in the Application Name field.

  4. From the Application Type drop-down, click Custom Integration.

  5. Type the description of the integration in the Description field.

  6. Paste the Callback URL you were provided in step 2 above in the Callback URL field. For example, https://beta-assistant-auth.jfrog.io/api/v1/oauth/callback.

    GitHubCopilotClientID-Secret.png

  7. Click Generate Client ID & Secret.

    GitHubIntegration.png

    Note

    Save Client ID and Secret to register the platform. The secret is currently visible and will not be retrievable at a later stage as it has not been saved in the system.

  8. Click Save.

  9. In the Client Settings dialog box, enter the following settings saved from creating custom integration, and then click Submit.

    • Client ID in the ClientID field

    • Client Secret in the Client Secret field

    GitHubCopilotClientSettings.png

  10. From the Authentication dialog box, copy the end users' authorization URL and share it with users. Note that, as an admin, you can share the link with others and also use it yourself to go through the user authorization process.

    AuthenticationURL.png

    For more information, see Configure JFrog GitHub Copilot Extension in IDE.