Skip to content

Commit 2bf90d9

Browse files
betegonclaude
andcommitted
docs: add SENTRY_HOST to env var references
Update configuration, self-hosted, and development docs to document SENTRY_HOST as the primary env var with SENTRY_URL as an alias. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6414868 commit 2bf90d9

File tree

3 files changed

+20
-12
lines changed

3 files changed

+20
-12
lines changed

DEVELOPMENT.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,11 @@ When creating your Sentry OAuth application:
6767

6868
## Environment Variables
6969

70-
| Variable | Description | Default |
71-
| ------------------ | ------------------------------------ | -------------------- |
72-
| `SENTRY_CLIENT_ID` | Sentry OAuth app client ID | (required) |
73-
| `SENTRY_URL` | Sentry instance URL (for self-hosted)| `https://sentry.io` |
70+
| Variable | Description | Default |
71+
| ------------------ | ----------------------------------------------------- | -------------------- |
72+
| `SENTRY_CLIENT_ID` | Sentry OAuth app client ID | (required) |
73+
| `SENTRY_HOST` | Sentry instance URL (for self-hosted, takes precedence) | `https://sentry.io` |
74+
| `SENTRY_URL` | Alias for `SENTRY_HOST` | `https://sentry.io` |
7475

7576
## Building
7677

docs/src/content/docs/configuration.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@ The Sentry CLI can be configured through environment variables and a local datab
77

88
## Environment Variables
99

10-
### `SENTRY_URL`
10+
### `SENTRY_HOST`
1111

1212
Base URL of your Sentry instance. **Only needed for [self-hosted Sentry](./self-hosted/).** SaaS users (sentry.io) should not set this.
1313

1414
```bash
15-
export SENTRY_URL=https://sentry.example.com
15+
export SENTRY_HOST=https://sentry.example.com
1616
```
1717

1818
When set, all API requests (including OAuth login) are directed to this URL instead of `https://sentry.io`. The CLI also sets this automatically when you pass a self-hosted Sentry URL as a command argument.
1919

20+
`SENTRY_HOST` takes precedence over `SENTRY_URL`. Both work identically — use whichever you prefer.
21+
22+
### `SENTRY_URL`
23+
24+
Alias for `SENTRY_HOST`. If both are set, `SENTRY_HOST` takes precedence.
25+
2026
### `SENTRY_ORG`
2127

2228
Default organization slug. Skips organization auto-detection.

docs/src/content/docs/self-hosted.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: Self-Hosted Sentry
33
description: Using the Sentry CLI with a self-hosted Sentry instance
44
---
55

6-
The CLI works with self-hosted Sentry instances. Set the `SENTRY_URL` environment variable to point at your instance:
6+
The CLI works with self-hosted Sentry instances. Set the `SENTRY_HOST` (or `SENTRY_URL`) environment variable to point at your instance:
77

88
```bash
9-
export SENTRY_URL=https://sentry.example.com
9+
export SENTRY_HOST=https://sentry.example.com
1010
```
1111

1212
## Authenticating
@@ -27,14 +27,14 @@ The OAuth device flow requires **Sentry 26.1.0 or later** and a public OAuth app
2727
Pass your instance URL and the client ID:
2828

2929
```bash
30-
SENTRY_URL=https://sentry.example.com SENTRY_CLIENT_ID=your-client-id sentry auth login
30+
SENTRY_HOST=https://sentry.example.com SENTRY_CLIENT_ID=your-client-id sentry auth login
3131
```
3232

3333
:::tip
3434
You can export both variables in your shell profile so every CLI invocation picks them up:
3535

3636
```bash
37-
export SENTRY_URL=https://sentry.example.com
37+
export SENTRY_HOST=https://sentry.example.com
3838
export SENTRY_CLIENT_ID=your-client-id
3939
```
4040
:::
@@ -48,7 +48,7 @@ If your instance is on an older version or you prefer not to create an OAuth app
4848
3. Pass it to the CLI:
4949

5050
```bash
51-
SENTRY_URL=https://sentry.example.com sentry auth login --token YOUR_TOKEN
51+
SENTRY_HOST=https://sentry.example.com sentry auth login --token YOUR_TOKEN
5252
```
5353

5454
## After Login
@@ -66,7 +66,8 @@ If you pass a self-hosted Sentry URL as a command argument (e.g., an issue or ev
6666

6767
| Variable | Description |
6868
|----------|-------------|
69-
| `SENTRY_URL` | Base URL of your Sentry instance |
69+
| `SENTRY_HOST` | Base URL of your Sentry instance (takes precedence over `SENTRY_URL`) |
70+
| `SENTRY_URL` | Alias for `SENTRY_HOST` |
7071
| `SENTRY_CLIENT_ID` | Client ID of your public OAuth application |
7172
| `SENTRY_ORG` | Default organization slug |
7273
| `SENTRY_PROJECT` | Default project slug (supports `org/project` format) |

0 commit comments

Comments
 (0)