Skip to content

Commit

Permalink
docs: add hints on GHE operating specifics
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Bezold <[email protected]>
  • Loading branch information
SebastianBezold committed Aug 15, 2024
1 parent cfb608c commit 485f3a8
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,16 @@ Allstar supports various operator configuration options which can be set via env
| ALLSTAR_LOG_LEVEL | The minimum logging level that allstar should use when emitting logs. Acceptable values are: panic ; fatal ; error ; warn ; info ; debug ; trace | info |
| NOTICE_PING_DURATION_HOURS | The duration (in hours) to wait between pinging notice actions, such as updating a GitHub issue. | 24 |

## Self-hosted GitHub Enterprise specifics

In case you want to operate Allstar with a self-hosted GitHub Enterprise instance, you need to set the `ALLSTAR_GHE_URL` environment variable to the URL of your GitHub Enterprise instance URL.
The different API endpoints for API and upload are appended automatically.

Example:

Given, your GHE instance URL is "https://my-ghe.example.com", you need to set the following environment variables:

```shell
export ALLSTAR_GHE_URL="https://my-ghe.example.com"
export GH_HOST="my-ghe.example.com" # This is somehow used within a dependency and (as of now) is unclear how to set it programmatically.
```

0 comments on commit 485f3a8

Please sign in to comment.