2b54bd4320
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
---
|
|
title: Configuring your server to host your Copilot extension
|
|
intro: 'Learn how to make your {% data variables.product.prodname_copilot_short %} extension accessible to the internet.'
|
|
versions:
|
|
feature: copilot-extensions
|
|
redirect_from:
|
|
- /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent
|
|
- /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-agent
|
|
topics:
|
|
- Copilot
|
|
shortTitle: Host your extension
|
|
type: how_to
|
|
---
|
|
|
|
Your {% data variables.product.prodname_copilot_extension_short %} must be hosted on a server that is accessible to the internet. In this guide, we will use [ngrok](https://ngrok.com/) to create a tunnel to your local server, but you could also use a service like [localtunnel](https://localtunnel.github.io/www/).
|
|
|
|
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](/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace).
|
|
|
|
## Prerequisites
|
|
|
|
* You have created a {% data variables.product.prodname_copilot_extension_short %}. For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension) or [AUTOTITLE](/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension).
|
|
|
|
## Configuring your server
|
|
|
|
1. Visit the [ngrok setup & installation page](https://dashboard.ngrok.com/get-started/setup/).
|
|
1. If you do not yet have an account, follow the instructions on screen to sign up.
|
|
1. Under "Agents," ensure the correct operating system is selected.
|
|
1. Under "Installation," follow the instructions for your operating system to download and install ngrok.
|
|
1. Under "Deploy your app online," select **Ephemeral domain** or **Static domain**.
|
|
1. 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 copy
|
|
ngrok http http://localhost:EXTENSION-PORT-NUMBER
|
|
```
|
|
|
|
* For a static domain:
|
|
|
|
```shell copy
|
|
ngrok http --domain=YOUR-STATIC-DOMAIN.ngrok-free.app EXTENSION-PORT-NUMBER
|
|
```
|
|
|
|
1. 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:XXXX` part of the URL.
|
|
>
|
|
> Keep the terminal window open while you are using your extension.
|
|
|
|
## Next steps
|
|
|
|
* [AUTOTITLE](/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension)
|