Configuring your server to host your Copilot agent

Learn how to make your Copilot agent accessible to the internet.

이 문서의 내용

Note

GitHub Copilot Extensions은(는) 공개 미리 보기 버전이며 변경될 수 있습니다.

Your Copilot agent 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 "codespace의 포트 전달."

Prerequisites

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 agent is configured to run on. For example:

    • For an ephemeral domain:

      Shell
      ngrok http http://localhost:AGENT-PORT-NUMBER

    • For a static domain:

      Shell
      ngrok http --domain=YOUR-STATIC-DOMAIN.ngrok-free.app AGENT-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 agent.

Next steps