Skip to content

Commit 79f18ee

Browse files
aldy505BYK
andauthored
docs: clearly state that system.internal-url-prefix shouldn't be changed (#3829)
* docs: clearly state that `system.internal-url-prefix` shouldn't be changed Happened today on Discord where a user changed internal-url-prefix and broke their instance. I think this should be stated clearer for new users and for non-native English speakers. * Apply suggestion from @BYK Co-authored-by: Burak Yigit Kaya <byk@sentry.io> * Apply suggestion from @aldy505 Co-authored-by: Reinaldy Rafli <github@reinaldyrafli.com> * Apply changes from @BYK --------- Co-authored-by: Burak Yigit Kaya <byk@sentry.io>
1 parent abe34d0 commit 79f18ee

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

sentry/config.example.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,18 @@ mail.host: 'smtp'
4545
# System Settings #
4646
###################
4747

48-
# The URL prefix in which Sentry is accessible
48+
# This is the main URL prefix where Sentry can be accessed.
49+
# Sentry will use this to create links to its different parts of the web UI.
50+
# This is most helpful if you are using an external reverse proxy.
4951
# system.url-prefix: https://example.sentry.com
52+
53+
# Most of the time, this should NOT be changed. It's used for communication
54+
# between containers. `web` is the container's name, and `9000` is the
55+
# default port opened by the Sentry backend (this is NOT the public port).
56+
#
57+
# If you want to change the publicly exposed domain or port, you should change
58+
# `system.url-prefix` above instead, along with `SENTRY_BIND` in `.env` file.
59+
# Also see https://develop.sentry.dev/self-hosted/#productionalizing.
5060
system.internal-url-prefix: 'http://web:9000'
5161

5262
# If this file ever becomes compromised, it's important to generate a new key.

0 commit comments

Comments
 (0)