diff --git a/develop-docs/development/environment/index.mdx b/develop-docs/development/environment/index.mdx index 525697e0a019f..f3f4a36c22d3a 100644 --- a/develop-docs/development/environment/index.mdx +++ b/develop-docs/development/environment/index.mdx @@ -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`. + + + 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. + + ### Ingestion Pipeline (Relay) aka Sending Events to your Dev Environment Relay 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: