Skip to content

docs: document SENTRY_URL and self-hosted setup#337

Merged
BYK merged 4 commits intomainfrom
fix/335-document-sentry-url-self-hosted
Mar 4, 2026
Merged

docs: document SENTRY_URL and self-hosted setup#337
BYK merged 4 commits intomainfrom
fix/335-document-sentry-url-self-hosted

Conversation

@BYK
Copy link
Member

@BYK BYK commented Mar 4, 2026

Add documentation for SENTRY_URL and self-hosted Sentry setup, which were previously undocumented (users had to find them through source code).

Changes

  • New Self-Hosted page — focused guide: OAuth device flow (requires 26.1.0+), creating a public OAuth application, passing SENTRY_CLIENT_ID, API token fallback for older versions
  • New Configuration page — full environment variable reference (10 vars) and credential storage details
  • Updated Installation page — brief self-hosted section with link to the guide
  • Updated auth command docs — self-hosted subsection under sentry auth login with version note

Closes #335

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


New Features ✨

Trace

Other

  • (api) Add --data/-d flag and auto-detect JSON body in fields by BYK in #320
  • (formatters) Render all terminal output as markdown by BYK in #297
  • (install) Add Sentry error telemetry to install script by BYK in #334
  • (issue-list) Global limit with fair distribution, compound cursor, and richer progress by BYK in #306
  • (log-list) Add --trace flag to filter logs by trace ID by BYK in #329
  • (project) Add project create command by betegon in #237
  • (upgrade) Add binary delta patching via TRDIFF10/bsdiff by BYK in #327

Bug Fixes 🐛

Api

  • Use numeric project ID to avoid "not actively selected" error by betegon in #312
  • Use limit param for issues endpoint page size by BYK in #309
  • Auto-correct ':' to '=' in --field values with a warning by BYK in #302

Formatters

  • Expand streaming table to fill terminal width by betegon in #314
  • Fix HTML entities and escaped underscores in table output by betegon in #313

Setup

  • Suppress agent skills and welcome messages on upgrade by BYK in #328
  • Suppress shell completion messages on upgrade by BYK in #326

Other

  • (ci) Generate JUnit XML to silence codecov-action warnings by BYK in #300
  • (install) Fix nightly digest extraction on macOS by BYK in #331
  • (nightly) Push to GHCR from artifacts dir so layer titles are bare filenames by BYK in #301
  • (project create) Auto-correct dot-separated platform to hyphens by BYK in #336
  • (region) Resolve DSN org prefix at resolution layer by BYK in #316
  • (test) Handle 0/-0 in getComparator anti-symmetry property test by BYK in #308
  • (trace-logs) Timestamp_precise is a number, not a string by BYK in #323
  • (upgrade) Use MAP_PRIVATE mmap to prevent macOS SIGKILL during delta upgrade by BYK in #339

Documentation 📚

  • Document SENTRY_URL and self-hosted setup by BYK in #337

Internal Changes 🔧

Api

  • Upgrade @sentry/api to 0.21.0, remove raw HTTP pagination workarounds by BYK in #321
  • Wire listIssuesPaginated through @sentry/api SDK for type safety by BYK in #310

Other

  • (craft) Add sentry-release-registry target by BYK in #325

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://cli.sentry.dev/pr-preview/pr-337/

Built to branch gh-pages at 2026-03-04 16:39 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

Codecov Results 📊

2631 passed | Total: 2631 | Pass Rate: 100% | Execution Time: 0ms

📊 Comparison with Base Branch

Metric Change
Total Tests
Passed Tests
Failed Tests
Skipped Tests

✨ No test changes detected

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 3126 uncovered lines.
✅ Project coverage is 82.43%. Comparing base (base) to head (head).

Coverage diff
@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
+ Coverage    82.43%    82.43%        —%
==========================================
  Files          126       126         —
  Lines        17792     17792         —
  Branches         0         0         —
==========================================
+ Hits         14666     14666         —
- Misses        3126      3126         —
- Partials         0         0         —

Generated by Codecov Action

@BYK BYK force-pushed the fix/335-document-sentry-url-self-hosted branch from a1f3ede to 5bf2bcc Compare March 4, 2026 14:45
BYK and others added 3 commits March 4, 2026 14:58
Add a dedicated Self-Hosted page with authentication guidance
(OAuth and API token flows) and a Configuration page documenting
all environment variables.

Add self-hosted pointers to the Installation page and auth command
reference so users can discover SENTRY_URL without reading source.

Closes #335
Address review feedback:
- OAuth app: Settings → Developer Settings → Applications → Create New
  Application → Public (not New Public Integration, no permissions needed)
- API token: Settings → Developer Settings → Personal Tokens
  (not Settings → API → Auth Tokens)
- List required token scopes explicitly
@BYK BYK force-pushed the fix/335-document-sentry-url-self-hosted branch from 33673f3 to e2663ef Compare March 4, 2026 15:00
@BYK BYK marked this pull request as ready for review March 4, 2026 16:02

1. In your Sentry instance, go to **Settings → Developer Settings → Applications → Create New Application** (or visit `https://sentry.example.com/settings/account/api/applications/`)
2. Select **Public** as the application type
3. Fill in the required fields (name, redirect URL — can be any placeholder URL)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Fill in the required fields (name, redirect URL — can be any placeholder URL)

@BYK BYK enabled auto-merge (squash) March 4, 2026 16:38
@BYK BYK merged commit 2233d3f into main Mar 4, 2026
21 checks passed
@BYK BYK deleted the fix/335-document-sentry-url-self-hosted branch March 4, 2026 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Problem authenticating to self-hosted instance

1 participant