You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b422dcf
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md
+23-4Lines changed: 23 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,6 +49,13 @@ You configure your model provider by setting environment variables before starti
49
49
|`COPILOT_PROVIDER_BASE_URL`| Yes | The base URL of your model provider's API endpoint. |
50
50
|`COPILOT_PROVIDER_TYPE`| No | The provider type: `openai` (default), `azure`, or `anthropic`. |
51
51
|`COPILOT_PROVIDER_API_KEY`| No | Your API key for the provider. Not required for providers that do not use authentication, such as a local Ollama instance. |
52
+
|`COPILOT_PROVIDER_BEARER_TOKEN`| No | Bearer token used for provider authentication when API-key authentication is not used. |
53
+
|`COPILOT_PROVIDER_WIRE_API`| No | Specifies the API protocol used when communicating with the provider. |
54
+
|`COPILOT_PROVIDER_AZURE_API_VERSION`| Azure only | The Azure OpenAI API version used for requests. |
55
+
|`COPILOT_PROVIDER_MODEL_ID`| No | The well-known model name used to identify model capabilities and token limits. |
56
+
|`COPILOT_PROVIDER_WIRE_MODEL`| No | The model name sent to the provider API for inference. For Azure OpenAI, use the deployment name. |
57
+
|`COPILOT_PROVIDER_MAX_PROMPT_TOKENS`| No | Maximum number of prompt tokens allowed in a request. |
58
+
|`COPILOT_PROVIDER_MAX_OUTPUT_TOKENS`| No | Maximum number of tokens generated in a response. |
52
59
|`COPILOT_MODEL`| Yes | The model identifier to use. You can also set this with the `--model` command-line flag. |
53
60
54
61
## Connecting to an OpenAI-compatible endpoint
@@ -81,17 +88,29 @@ Use the following steps if you are connecting to OpenAI, Ollama, vLLM, Foundry L
81
88
1. Set the environment variables for Azure OpenAI.
*`YOUR-RESOURCE-NAME`: your Azure OpenAI resource name
93
-
*`YOUR-DEPLOYMENT-NAME`: the name of your model deployment
94
-
*`YOUR-AZURE-API-KEY`: your Azure OpenAI API key
102
+
*`YOUR-RESOURCE-NAME`: your Azure OpenAI resource name
103
+
*`YOUR-DEPLOYMENT-NAME`: the deployment name that receives requests
104
+
*`YOUR-MODEL-NAME`: the underlying model associated with the deployment (for example, `gpt-4o`)
105
+
*`YOUR-AZURE-API-VERSION`: the Azure OpenAI API version
106
+
*`YOUR-AZURE-API-KEY`: your Azure OpenAI API key
107
+
108
+
### Azure-specific environment variables
109
+
110
+
| Variable | Description |
111
+
|---|---|
112
+
|`COPILOT_PROVIDER_MODEL_ID`| The well-known model name. {% data variables.copilot.copilot_cli_short %} uses this value to identify model capabilities and token limits. |
113
+
|`COPILOT_PROVIDER_WIRE_MODEL`| The Azure OpenAI deployment name. Azure OpenAI routes requests through deployments rather than directly through model names. |
95
114
96
115
{% data reusables.copilot.copilot-cli.start-cli %}
Copy file name to clipboardExpand all lines: content/copilot/how-tos/copilot-on-github/customize-copilot/customize-cloud-agent/customize-the-agent-environment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ A `copilot-setup-steps.yml` file looks like a normal {% data variables.product.p
51
51
52
52
Here is a simple example of a `copilot-setup-steps.yml` file for a TypeScript project that clones the project, installs Node.js and downloads and caches the project's dependencies. You should customize this to fit your own project, including its language(s), its dependencies, and the workflow triggers you need. For example, you wouldn't typically run on both `push` and `pull_request`.
53
53
54
-
```yaml copy
54
+
```yaml
55
55
name: "Copilot Setup Steps"
56
56
57
57
# Automatically run the setup steps when they are changed to allow for easy validation, and
Copy file name to clipboardExpand all lines: content/copilot/tutorials/cloud-agent/improve-a-project.md
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ Creating this file is optional but is a good idea if you use {% data variables.c
79
79
80
80
<!-- markdownlint-disable -->
81
81
```text copy
82
-
Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for {% data variables.copilot.copilot_cloud_agent %}, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`.
82
+
Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for {% data variables.copilot.copilot_cloud_agent %}, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`, and that the workflow includes a `workflow_dispatch` trigger so that it can be run manually. Choose any other triggers to suit this repository; there's no need to run on both `push` and `pull_request`.
83
83
```
84
84
<!-- markdownlint-enable -->
85
85
@@ -97,12 +97,6 @@ Creating this file is optional but is a good idea if you use {% data variables.c
@@ -225,23 +225,23 @@ You also need to add the `.npmrc` file to your project so that all requests to i
225
225
226
226
### Installing packages from other organizations
227
227
228
-
By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your `.npmrc` file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE`with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}.
228
+
By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your `.npmrc` file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE1` and `NAMESPACE2`with the names of the personal accounts or organizations {% ifversion packages-npm-v2 %}to which the packages are scoped{% else %}that own the repositories containing the projects{% endif %}.
229
229
230
230
{% ifversion ghes %}
231
231
If your instance has subdomain isolation enabled:
232
232
{% endif %}
233
233
234
234
```shell
235
-
@NAMESPACE:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %}
236
-
@NAMESPACE:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %}
235
+
@NAMESPACE1:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %}
236
+
@NAMESPACE2:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %}
237
237
```
238
238
239
239
{% ifversion ghes %}
240
240
If your instance has subdomain isolation disabled:
Copy file name to clipboardExpand all lines: content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,6 +123,8 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl
123
123
124
124
1. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com`for your user site, create a `CNAME` record that points `www.example.com` to `<user>.github.io`. If you want to use the subdomain `another.example.com`for your organization site, create a `CNAME` record that points `another.example.com` to `<organization>.github.io`. The `CNAME` record should always point to `<user>.github.io` or `<organization>.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %}
125
125
126
+
These `CNAME` record values are the same forboth publicly and privately published {% data variables.product.prodname_pages %} sites. Do not point the `CNAME` record to the unique `*.pages.github.io` subdomain shownin your repository's {% data variables.product.prodname_pages %} settings. Privately published sites are available with {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/enterprise-cloud@latest/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}.
0 commit comments