diff --git a/develop-docs/self-hosted/csp.mdx b/develop-docs/self-hosted/experimental/csp.mdx similarity index 91% rename from develop-docs/self-hosted/csp.mdx rename to develop-docs/self-hosted/experimental/csp.mdx index 5fe1b45f2744d..7243621d77fb7 100644 --- a/develop-docs/self-hosted/csp.mdx +++ b/develop-docs/self-hosted/experimental/csp.mdx @@ -5,7 +5,7 @@ sidebar_order: 70 --- - This is an experimental feature. Use it with caution. + This is an experimental feature. This means that features and workflows are not completely tested, so use at your own risk! Starting with Sentry `23.5.0`, it is possible to enable the [CSP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) on self-hosted Sentry installations. The good news is that Sentry itself supports [collecting of CSP reports](https://docs.sentry.io/product/security-policy-reporting/). We recommend creating a separate Sentry project for CSP reports. To enable CSP and reports collection, you'll want to configure the following settings in `sentry.conf.py`: diff --git a/develop-docs/self-hosted/experimental/errors-only.mdx b/develop-docs/self-hosted/experimental/errors-only.mdx new file mode 100644 index 0000000000000..86ffb40b010cd --- /dev/null +++ b/develop-docs/self-hosted/experimental/errors-only.mdx @@ -0,0 +1,37 @@ +--- +title: Errors Only Self-hosted +sidebar_title: Errors Only +sidebar_order: 100 +--- + + + This is an experimental feature. This means that features and workflows are not completely tested, so use at your own risk! + + +Starting from 24.8.0+, users will have the ability to choose between two distinct types of self-hosted Sentry deployments. + +**Errors Only** + +Errors Only self-hosted offers a small subset of features with an emphasis on minimizing system resources. This lightweight option includes only the following features: +1. Issues +2. Alerts +3. Integrations +4. Dashboards +5. Releases +6. Discover + +In order to enable errors only self-hosted, you'll need to update your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) to include `COMPOSE_PROFILES=errors-only`. + +**Feature Complete** + +This is our default version of self-hosted Sentry. It includes most of the features that are available on our SaaS product. This includes everything offered in the Errors Only version, plus the following: +1. [Traces](https://docs.sentry.io/product/explore/traces/) +2. [Profiles](https://docs.sentry.io/product/explore/profiling/) +3. [Replays](https://docs.sentry.io/product/explore/session-replay/) +4. [Insights](https://docs.sentry.io/product/insights/) (Requests, Queries, Assets, etc) +5. [User Feedback](https://docs.sentry.io/product/user-feedback/) +6. [Performance](https://docs.sentry.io/product/performance/) +7. [Crons](https://docs.sentry.io/product/crons/) +8. [Metrics](https://docs.sentry.io/product/explore/metrics/) + +This version of Sentry is enabled by default upon installation. Ensure that your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) includes `COMPOSE_PROFILES=feature-complete`. \ No newline at end of file diff --git a/develop-docs/self-hosted/external-storage.mdx b/develop-docs/self-hosted/experimental/external-storage.mdx similarity index 95% rename from develop-docs/self-hosted/external-storage.mdx rename to develop-docs/self-hosted/experimental/external-storage.mdx index 8e3772bcb664d..64ba4dbe3ff1a 100644 --- a/develop-docs/self-hosted/external-storage.mdx +++ b/develop-docs/self-hosted/experimental/external-storage.mdx @@ -7,7 +7,7 @@ sidebar_order: 90 In some cases, storing Sentry data on-disk is not really something people can do. Sometimes, it's better to offload it into some bucket storage (like AWS S3 or Google Cloud Storage). - The docs below are contributed by the community. Sentry does not officially provide support for external storage backends that extend beyond our typical docker compose setup. Follow these guidelines at your own risk as these docs are not maintained nor kept up to date! + These are community-contributed docs. Sentry does not officially provide support for self-hosted configurations beyond the default install. After changing configuration files, re-run the ./install.sh script, to rebuild and restart the containers. See the configuration section for more information. diff --git a/develop-docs/self-hosted/experimental/index.mdx b/develop-docs/self-hosted/experimental/index.mdx new file mode 100644 index 0000000000000..0889cc986d786 --- /dev/null +++ b/develop-docs/self-hosted/experimental/index.mdx @@ -0,0 +1,7 @@ +--- +title: Experimental Configurations +--- + +These pages here are purely experimental and are not officially supported workflows. Much of this is contributed by our wonderful developer community. We hope it is useful for those customizing self-hosted Sentry to your specific needs, but are unable to offer official support or triage for issues arising from these workflows. **Use at your own risk!** + + diff --git a/develop-docs/self-hosted/reverse-proxy.mdx b/develop-docs/self-hosted/experimental/reverse-proxy.mdx similarity index 98% rename from develop-docs/self-hosted/reverse-proxy.mdx rename to develop-docs/self-hosted/experimental/reverse-proxy.mdx index b2418cbe3474c..6c353a9fac119 100644 --- a/develop-docs/self-hosted/reverse-proxy.mdx +++ b/develop-docs/self-hosted/experimental/reverse-proxy.mdx @@ -4,6 +4,10 @@ sidebar_title: Reverse Proxy sidebar_order: 80 --- + + These are community-contributed docs. Sentry does not officially provide support for self-hosted configurations beyond the default install. + + Adding a reverse proxy in front of your Sentry deployment is strongly recommended for one big reason: you can fine tune every configuration to fit your current setup. A dedicated reverse proxy that does SSL/TLS termination that also forwards the client IP address as Docker Compose internal network (as this is [close to impossible to get otherwise](https://github.com/getsentry/self-hosted/issues/554)) would give you the best Sentry experience. Once you have setup a reverse proxy to your Sentry instance, you should modify the `system.url-prefix` in the `config.yml` file to match your new URL and protocol. You should also update the SSL/TLS section in the `sentry/sentry.conf.py` script, otherwise you may get CSRF-related errors when performing certain actions such as configuring integrations. diff --git a/develop-docs/self-hosted/index.mdx b/develop-docs/self-hosted/index.mdx index 20c60cb6f6ffb..71cd7db789278 100644 --- a/develop-docs/self-hosted/index.mdx +++ b/develop-docs/self-hosted/index.mdx @@ -124,38 +124,6 @@ To apply new Docker daemon configuration, restart your Docker service with `syst Further information regarding Docker default IP pools can be found on the [Troubleshooting guide](/self-hosted/troubleshooting/#docker-network-conflicting-ip-address). -## Errors-only Self-hosted Sentry - -**Disclaimer: This is an experimental beta feature. This means that features and workflows are not completely tested, so use at your own risk!** - -Starting from 24.8.0+, users will have the ability to choose between two distinct types of self-hosted Sentry deployments. - -**Errors Only** - -Errors Only self-hosted offers a small subset of features with an emphasis on minimizing system resources. This lightweight option includes only the following features: -1. Issues -2. Alerts -3. Integrations -4. Dashboards -5. Releases -6. Discover - -In order to enable errors only self-hosted, you'll need to update your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) to include `COMPOSE_PROFILES=errors-only`. - -**Feature Complete** - -This is our default version of self-hosted Sentry. It includes most of the features that are available on our SaaS product. This includes everything offered in the Errors Only version, plus the following: -1. [Traces](https://docs.sentry.io/product/explore/traces/) -2. [Profiles](https://docs.sentry.io/product/explore/profiling/) -3. [Replays](https://docs.sentry.io/product/explore/session-replay/) -4. [Insights](https://docs.sentry.io/product/insights/) (Requests, Queries, Assets, etc) -5. [User Feedback](https://docs.sentry.io/product/user-feedback/) -6. [Performance](https://docs.sentry.io/product/performance/) -7. [Crons](https://docs.sentry.io/product/crons/) -8. [Metrics](https://docs.sentry.io/product/explore/metrics/) - -This version of Sentry is enabled by default upon installation. Ensure that your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) includes `COMPOSE_PROFILES=feature-complete`. - ## Configuration You very likely will want to adjust the default configuration for your Sentry installation as well. These facilities are available for that purpose: @@ -224,7 +192,8 @@ Here is further information on specific configuration topics related to self-hos - [Email](/self-hosted/email/) - [Geolocation](/self-hosted/geolocation/) - [Single Sign-On (SSO)](/self-hosted/sso/) -- [Content Security Policy](/self-hosted/csp/) +- [Content Security Policy](/self-hosted/experimental/csp/) +- [Errors Only](/self-hosted/experimental/errors-only/) ## Productionalizing