Skip to content

Commit 228cd74

Browse files
authored
doc: add auth_provider_url setting to readme (#429)
1 parent 5a8fdd3 commit 228cd74

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ gh auth token
4444
Set either the environment variable `GITHUB_COPILOT_TOKEN` or `GH_COPILOT_TOKEN` to that token.
4545
Note that if you have the variable set, even empty, the LSP will attempt to use it to log in.
4646

47+
#### Authentication with Alternate GitHub Instances
48+
49+
If your access to Copilot is not provided by the public GitHub instance, you can set your
50+
authentication provider to a custom URL with the corresponding config key e.g.
51+
`auth_provider_url = "https://mycorp.ghe.com/"`.
52+
4753
## Setup and Configuration
4854

4955
You have to run the `require("copilot").setup(options)` function in order to start Copilot.
@@ -107,6 +113,7 @@ require('copilot').setup({
107113
cvs = false,
108114
["."] = false,
109115
},
116+
auth_provider_url = nil, -- URL to authentication provider, if not "https://github.com/"
110117
logger = {
111118
file = vim.fn.stdpath("log") .. "/copilot-lua.log",
112119
file_log_level = vim.log.levels.OFF,

0 commit comments

Comments
 (0)