Skip to content

Commit 5c9cf4a

Browse files
feat(self-hosted): Add experimental page (#11473)
* add experimental page
1 parent 10db65d commit 5c9cf4a

File tree

6 files changed

+52
-35
lines changed

6 files changed

+52
-35
lines changed

develop-docs/self-hosted/csp.mdx renamed to develop-docs/self-hosted/experimental/csp.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_order: 70
55
---
66

77
<Alert level="warning">
8-
This is an experimental feature. Use it with caution.
8+
This is an experimental feature. This means that features and workflows are not completely tested, so use at your own risk!
99
</Alert>
1010

1111
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`:
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Errors Only Self-hosted
3+
sidebar_title: Errors Only
4+
sidebar_order: 100
5+
---
6+
7+
<Alert level="warning">
8+
This is an experimental feature. This means that features and workflows are not completely tested, so use at your own risk!
9+
</Alert>
10+
11+
Starting from 24.8.0+, users will have the ability to choose between two distinct types of self-hosted Sentry deployments.
12+
13+
**Errors Only**
14+
15+
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:
16+
1. Issues
17+
2. Alerts
18+
3. Integrations
19+
4. Dashboards
20+
5. Releases
21+
6. Discover
22+
23+
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`.
24+
25+
**Feature Complete**
26+
27+
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:
28+
1. [Traces](https://docs.sentry.io/product/explore/traces/)
29+
2. [Profiles](https://docs.sentry.io/product/explore/profiling/)
30+
3. [Replays](https://docs.sentry.io/product/explore/session-replay/)
31+
4. [Insights](https://docs.sentry.io/product/insights/) (Requests, Queries, Assets, etc)
32+
5. [User Feedback](https://docs.sentry.io/product/user-feedback/)
33+
6. [Performance](https://docs.sentry.io/product/performance/)
34+
7. [Crons](https://docs.sentry.io/product/crons/)
35+
8. [Metrics](https://docs.sentry.io/product/explore/metrics/)
36+
37+
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`.

develop-docs/self-hosted/external-storage.mdx renamed to develop-docs/self-hosted/experimental/external-storage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_order: 90
77
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).
88

99
<Alert title="Important" level="warning">
10-
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!
10+
These are community-contributed docs. Sentry does not officially provide support for self-hosted configurations beyond the default install.
1111
</Alert>
1212
<Alert title="Note" level="info">
1313
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Experimental Configurations
3+
---
4+
5+
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!**
6+
7+
<PageGrid />

develop-docs/self-hosted/reverse-proxy.mdx renamed to develop-docs/self-hosted/experimental/reverse-proxy.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ sidebar_title: Reverse Proxy
44
sidebar_order: 80
55
---
66

7+
<Alert title="Important" level="warning">
8+
These are community-contributed docs. Sentry does not officially provide support for self-hosted configurations beyond the default install.
9+
</Alert>
10+
711
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.
812

913
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.

develop-docs/self-hosted/index.mdx

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -124,38 +124,6 @@ To apply new Docker daemon configuration, restart your Docker service with `syst
124124
Further information regarding Docker default IP pools can be found on the [Troubleshooting guide](/self-hosted/troubleshooting/#docker-network-conflicting-ip-address).
125125
</Alert>
126126

127-
## Errors-only Self-hosted Sentry
128-
129-
**Disclaimer: This is an experimental beta feature. This means that features and workflows are not completely tested, so use at your own risk!**
130-
131-
Starting from 24.8.0+, users will have the ability to choose between two distinct types of self-hosted Sentry deployments.
132-
133-
**Errors Only**
134-
135-
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:
136-
1. Issues
137-
2. Alerts
138-
3. Integrations
139-
4. Dashboards
140-
5. Releases
141-
6. Discover
142-
143-
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`.
144-
145-
**Feature Complete**
146-
147-
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:
148-
1. [Traces](https://docs.sentry.io/product/explore/traces/)
149-
2. [Profiles](https://docs.sentry.io/product/explore/profiling/)
150-
3. [Replays](https://docs.sentry.io/product/explore/session-replay/)
151-
4. [Insights](https://docs.sentry.io/product/insights/) (Requests, Queries, Assets, etc)
152-
5. [User Feedback](https://docs.sentry.io/product/user-feedback/)
153-
6. [Performance](https://docs.sentry.io/product/performance/)
154-
7. [Crons](https://docs.sentry.io/product/crons/)
155-
8. [Metrics](https://docs.sentry.io/product/explore/metrics/)
156-
157-
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`.
158-
159127
## Configuration
160128

161129
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
224192
- [Email](/self-hosted/email/)
225193
- [Geolocation](/self-hosted/geolocation/)
226194
- [Single Sign-On (SSO)](/self-hosted/sso/)
227-
- [Content Security Policy](/self-hosted/csp/)
195+
- [Content Security Policy](/self-hosted/experimental/csp/)
196+
- [Errors Only](/self-hosted/experimental/errors-only/)
228197

229198
## Productionalizing
230199

0 commit comments

Comments
 (0)