Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Bring back self-signed cert docs and expand with reverse-proxy note #11520

Merged
merged 3 commits into from
Oct 8, 2024
Merged

docs: Bring back self-signed cert docs and expand with reverse-proxy note #11520

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2845b41
docs: Bring back self-signed cert docs and expand with reverse-proxy …
ryan953 Oct 8, 2024
e01ee64
split install/setup from runtime instructions
ryan953 Oct 8, 2024
680d425
Update develop-docs/development/environment/index.mdx
ryan953 Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions develop-docs/development/environment/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,32 @@ You can create other users with `sentry createuser`.

Please refer to [Frontend Development Server](/frontend/development-server/) and [Backend Development Server](/backend/development-server/) for alternative ways to bring up the Sentry UI.

### Enabling HTTPS

Optionally, you may wish to run the development server over HTTPS, for certain situations (like testing JS APIs that require a secure context).

First we will use [mkcert](https://github.com/FiloSottile/mkcert) to create and install a locally-trusted, development certificate and [Caddy](https://caddyserver.com/) as our reverse proxy.

```shell
brew install mkcert
brew install nss # if you use Firefox
brew install caddy
yarn mkcert-localhost
```

Then we will run the reverse proxy as needed:
```shell
yarn https-proxy
```

After the server is running we can visit the dev server using `https` at port `:8003` instead of over `http` at `:8000`.

<Alert title="HTTP Strict-Transport-Security" level="info">
You might get into a situation where [HSTS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) is enabled for your domain and you're unable to visit using `http` anymore.

To clear the HSTS visit `chrome://net-internals/#hsts` in Chrome based browsers and use the "Delete domain security policies" form.
</Alert>

### Ingestion Pipeline (Relay) aka Sending Events to your Dev Environment

<Link to="/services/relay/">Relay</Link> and the ingest workers are not started by default. Follow the instructions below to start them so you can send events to your dev environment Sentry instance:
Expand Down
Loading