Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Jason Etcovitch <jasonetco@github.com> Co-authored-by: Jess Hosman <1183847+jhosman@users.noreply.github.com> Co-authored-by: Dimitrios Philliou <d1m1tr10s@github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com>
2.9 KiB
title, intro, versions, topics, shortTitle, type
| title | intro | versions | topics | shortTitle | type | |||
|---|---|---|---|---|---|---|---|---|
| Configuring your server to deploy your Copilot agent | Learn how to deploy your {% data variables.product.prodname_copilot_short %} agent to a server that is accessible to the internet. |
|
|
Deploy your agent | how_to |
{% data reusables.copilot.copilot-extensions.beta-note %}
Your {% data variables.product.prodname_copilot_agent_short %} must be hosted on a server that is accessible to the internet. This guide will help you set up a server to run your {% data variables.product.prodname_copilot_agent_short %}. 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 {% data variables.product.prodname_codespaces %} user, you can use the built-in {% data variables.product.prodname_codespaces %} port forwarding. For more information, see "AUTOTITLE."
Prerequisites
- You have created a {% data variables.product.prodname_copilot_agent_short %}. For more information, see "AUTOTITLE." Alternatively, you can use a demo agent. For more information, see "AUTOTITLE."
Configuring your server
-
Visit the ngrok setup & installation page.
-
If you do not yet have an account, follow the instructions on screen to sign up.
-
Under "Agents," ensure the correct operating system is selected.
-
Under "Installation," follow the instructions for your operating system to download and install ngrok.
-
Under "Deploy your app online," selection Ephemeral domain or Static domain.
-
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:
ngrok http http://localhost:3000 -
For a static domain:
ngrok http --domain=YOUR-STATIC-DOMAIN.ngrok-free.app 3000[!NOTE] The Blackbeard demo extension is configured to run on port 3000 by default.
-
-
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 {% data variables.product.prodname_github_app %}.
[!NOTE] Do not copy the
-> http://localhost:XXXXpart of the URL.Keep the terminal window open while you are using your agent.