Skip to content

Commit 0c9542f

Browse files
authored
docs: Bring back self-signed cert docs and expand with reverse-proxy note (#11520)
1 parent a8ccf74 commit 0c9542f

File tree

1 file changed

+26
-0
lines changed
  • develop-docs/development/environment

1 file changed

+26
-0
lines changed

develop-docs/development/environment/index.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,32 @@ You can create other users with `sentry createuser`.
5555

5656
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.
5757

58+
### Enabling HTTPS
59+
60+
Optionally, you may wish to run the development server over HTTPS, for certain situations (like testing JS APIs that require a secure context).
61+
62+
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.
63+
64+
```shell
65+
brew install mkcert
66+
brew install nss # if you use Firefox
67+
brew install caddy
68+
yarn mkcert-localhost
69+
```
70+
71+
Then we will run the reverse proxy as needed:
72+
```shell
73+
yarn https-proxy
74+
```
75+
76+
After the server is running we can visit the dev server using `https` at port `:8003` instead of over `http` at `:8000`.
77+
78+
<Alert title="HTTP Strict-Transport-Security" level="info">
79+
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.
80+
81+
To clear the HSTS visit `chrome://net-internals/#hsts` in Chrome based browsers and use the "Delete domain security policies" form.
82+
</Alert>
83+
5884
### Ingestion Pipeline (Relay) aka Sending Events to your Dev Environment
5985

6086
<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:

0 commit comments

Comments
 (0)