164e19962b
Co-authored-by: Claire W <78226508+crwaters16@users.noreply.github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>
3.3 KiB
title, intro, versions, redirect_from, topics, shortTitle, contentType, category
| title | intro | versions | redirect_from | topics | shortTitle | contentType | category | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Configuring your server to host your GitHub Copilot extension | Learn how to make your {% data variables.product.prodname_copilot_short %} extension accessible to the internet. |
|
|
|
Host your extension | how-tos |
|
Your {% data variables.copilot.copilot_extension_short %} 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.
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.copilot.copilot_extension_short %}. For more information, see AUTOTITLE or 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," select Ephemeral domain or Static domain.
-
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:
ngrok http http://localhost:EXTENSION-PORT-NUMBER -
For a static domain:
ngrok http --domain=YOUR-STATIC-DOMAIN.ngrok-free.app EXTENSION-PORT-NUMBER
-
-
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 extension.