Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 6.75 KB

configuring-your-github-app-for-your-copilot-extension.md

File metadata and controls

84 lines (65 loc) · 6.75 KB
title intro defaultTool versions topics shortTitle type redirect_from
Configuring your GitHub App for your Copilot extension
Learn how to configure your {% data variables.product.prodname_github_app %} so that it is associated with your {% data variables.product.prodname_copilot_extension_short %}.
agents
feature
copilot-extensions
Copilot
Configure App for extension
how_to
/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-agent

{% data reusables.copilot.copilot-extensions.public-preview-note %}

Once you have configured your server and created your {% data variables.product.prodname_github_app %}, you need to configure your {% data variables.product.prodname_github_app %} for use with your {% data variables.product.prodname_copilot_short %} extension.

Prerequisites

  • You have configured your server to deploy your {% data variables.product.prodname_copilot_extension_short %}, and you have your hostname (aka forwarding endpoint). For more information, see AUTOTITLE.
  • You have created a {% data variables.product.prodname_github_app %} for your {% data variables.product.prodname_copilot_short %} extension. For more information, see AUTOTITLE.

Configuring your {% data variables.product.prodname_github_app %}

{% agents %}

{% data reusables.apps.settings-step %} {% data reusables.apps.enterprise-apps-steps %}

  1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.product.prodname_copilot_extension_short %}, click Edit.

  2. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click Save changes.

    [!NOTE] Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. See AUTOTITLE.

    If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  3. In the left sidebar, click Permissions & events.

  4. To expand the "Account permissions" section, click anywhere in the section. {% data reusables.copilot.copilot-extensions.account-permissions %}

  5. In the left sidebar, click {% data variables.product.prodname_copilot_short %}.

  6. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.product.prodname_copilot_extension_short %}.

  7. In the "App type" section, select the dropdown menu, then click Agent.

  8. Under "URL," enter your server's hostname (aka forwarding endpoint) that you copied from your terminal.

    [!NOTE] If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  9. Under "Inference description", type a brief description of your agent, then click Save. This will be the description users see when they hover over your extension's slug in the chat window.

  10. Your pre-authorization URL is a link on your website that starts the authorization process for your extension. Users will be redirected to this URL when they decide to authorize your extension. If you are using a pre-authorization URL, under "Pre-authorization URL," enter the URL, then click Save changes.

  11. In your {% data variables.product.prodname_github_app %} settings, in the left sidebar, click Install App, then, next to the account you want to install your app on, click Install. {% data reusables.copilot.go-to-copilot-page %}

  12. Invoke your extension by typing @EXTENSION-NAME, replacing any spaces in the extension name with -, then press Enter.

  13. If this is your first time using the extension, you will be prompted to authenticate. Follow the steps on screen to authenticate your extension.

  14. Ask your extension a question in the chat window. For example, What is the software development lifecycle?.

{% endagents %}

{% skillsets %}

{% data reusables.apps.settings-step %} {% data reusables.apps.enterprise-apps-steps %}

  1. To the right of the {% data variables.product.prodname_github_app %} you want to configure for your {% data variables.product.prodname_copilot_extension_short %}, click Edit.

  2. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click Save changes.

    [!NOTE] Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. See AUTOTITLE.

    If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  3. In the left sidebar, click Permissions & events.

  4. To expand the "Account permissions" section, click anywhere in the section. {% data reusables.copilot.copilot-extensions.account-permissions %}

  5. In the left sidebar, click {% data variables.product.prodname_copilot_short %}.

  6. Read the {% data variables.product.prodname_marketplace %} Developer Agreement and the {% data variables.product.github %} Pre-release License Terms, then accept the terms for creating a {% data variables.product.prodname_copilot_extension_short %}.

  7. In the "App type" section, select the dropdown menu, then click Skillset.

  8. Your pre-authorization URL is a link on your website that starts the authorization process for your extension. Users will be redirected to this URL when they decide to authorize your extension. If you are using a pre-authorization URL, under "Pre-authorization URL," enter the URL, then click Save changes. {% data reusables.copilot.copilot-extensions.skillsets-configuration-steps %}

  9. In your {% data variables.product.prodname_github_app %} settings, in the left sidebar, click Install App, then, next to the account you want to install your app on, click Install. {% data reusables.copilot.go-to-copilot-page %}

  10. Invoke your extension by typing @EXTENSION-NAME, replacing any spaces in the extension name with -, then press Enter.

  11. If this is your first time using the extension, you will be prompted to authenticate. Follow the steps on screen to authenticate your extension.

  12. Ask your extension a question in the chat window. For example, What is the software development lifecycle?.

{% endskillsets %}