Skip to content

Commit

Permalink
doc/auth: Mention GitHub Enterprise (#299)
Browse files Browse the repository at this point in the history
In #293, @messense confirmed that these settings work on GHES.
Adding to documentation for others who need direction.
  • Loading branch information
abhinav authored Jul 24, 2024
1 parent f881f0e commit 163c5f3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/src/setup/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,20 @@ However, it requires manual token management, making it less convenient.
[GITHUB_TOKEN](#github_token) is the least convenient and the least secure method.
It is intended only for CI/CD environments where you have no other choice.

## GitHub Enterprise

To use git-spice with a GitHub Enterprise instance,
set the following environment variables in your shell configuration file,
authenticate, and use git-spice as usual.

```freeze language="bash"
# URL of your GitHub Enterprise instance.
export GITHUB_URL=https://github.example.com
# URL at which the GitHub API is available on your instance.
export GITHUB_API_URL=https://github.example.com/api
```

## Safety

By default, git-spice stores your GitHub authentication token
Expand Down

0 comments on commit 163c5f3

Please sign in to comment.