Configuring your server to host your Copilot extension

Your Copilot Extension must be hosted on a server that is accessible to the internet. In this guide, we will use ngrok to create a tunnel to your local server, but you could also use a service like localtunnel or serveo.

Alternatively, if you are a Codespaces user, you can use the built-in Codespaces port forwarding. For more information, see "代码空间中的转发端口."

Prerequisites

• You have created a Copilot Extension. For more information, see "为 Copilot 扩展生成 Copilot 代理 or Building a Copilot skillset for your Copilot Extension."

Configuring your server

1. Visit the ngrok setup & installation page.

2. If you do not yet have an account, follow the instructions on screen to sign up.

3. Under "Agents," ensure the correct operating system is selected.

4. Under "Installation," follow the instructions for your operating system to download and install ngrok.

5. Under "Deploy your app online," select Ephemeral domain or Static domain.

6. Run the command provided in your terminal, replacing the port number with the port your extension is configured to run on. For example:

   • For an ephemeral domain:

     Shell

     ngrok http http://localhost:EXTENSION-PORT-NUMBER
     

   • For a static domain:

     Shell

     ngrok http --domain=YOUR-STATIC-DOMAIN.ngrok-free.app EXTENSION-PORT-NUMBER
     

7. In your terminal, next to "Forwarding," copy the URL that ngrok has assigned to your server. You will need this forwarding endpoint when you are configuring your GitHub App.

   Note

   Do not copy the -> http://localhost:XXXX part of the URL.

   Keep the terminal window open while you are using your extension.

Next steps

• 为 Copilot 扩展创建 GitHub 应用