Skip to content

Commit d6f33dd

Browse files
committed
Add documentation for new warnings
1 parent 6590d03 commit d6f33dd

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ running on your own infrastructure.
2727
monitoring
2828
beacon
2929
plugins
30+
warnings
3031
faq
3132

3233
.. sentry:edition:: self, on-premise

docs/warnings.rst

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
System Warnings
2+
===============
3+
4+
Deprecated Settings
5+
-------------------
6+
7+
Beginning with Sentry 8.0 configuration settings have started migrating from
8+
the original ``sentry.conf.py`` over into a new format ``config.yml``. We refer
9+
to the new format as ``SENTRY_OPTIONS``.
10+
11+
For example, ``SENTRY_OPTIONS["system.admin-email"]`` means, put
12+
``system.admin-email`` into ``config.yml``.
13+
14+
In Sentry 8.3, we have begun deprecating some settings from the old ``sentry.conf.py``
15+
and will soon be only accepting the new values from the new ``config.yml`` file.
16+
17+
Historically, ``SENTRY_CONF`` or ``--config`` was pointed directly to your
18+
``sentry.conf.py``, such as::
19+
20+
$ SENTRY_CONF=/etc/sentry/sentry.conf.py sentry start
21+
22+
Now, ``SENTRY_CONF`` should be pointed to the parent directory that contains both
23+
the python file and the yaml file. ``sentry init`` will generate the right
24+
structure needed for the future.::
25+
26+
$ SENTRY_CONF=/etc/sentry sentry start
27+
28+
The following will be a simple mapping of old (``sentry.conf.py``) keys to new
29+
(``config.yml``). Old settings should be completely removed.
30+
31+
General
32+
~~~~~~~
33+
34+
.. describe:: SENTRY_ADMIN_EMAIL
35+
36+
::
37+
38+
system.admin-email: '[email protected]'
39+
40+
.. describe:: SENTRY_URL_PREFIX
41+
42+
::
43+
44+
system.url-prefix: 'http://example.com'
45+
46+
.. describe:: SENTRY_SYSTEM_MAX_EVENTS_PER_MINUTE
47+
48+
::
49+
50+
system.rate-limit: 10
51+
52+
.. describe:: SECRET_KEY
53+
54+
::
55+
56+
system.secret-key: 'abc123'
57+
58+
59+
Mail
60+
~~~~
61+
62+
.. describe:: EMAIL_BACKEND
63+
64+
::
65+
66+
mail.backend: 'smtp'
67+
68+
69+
.. describe:: EMAIL_HOST
70+
71+
::
72+
73+
mail.host: 'localhost'
74+
75+
.. describe:: EMAIL_PORT
76+
77+
::
78+
79+
mail.port: 25
80+
81+
.. describe:: EMAIL_HOST_USER
82+
83+
::
84+
85+
mail.username: 'sentry'
86+
87+
.. describe:: EMAIL_HOST_PASSWORD
88+
89+
::
90+
91+
mail.password: 'nobodywillguessthisone'
92+
93+
.. describe:: EMAIL_USE_TLS
94+
95+
::
96+
97+
mail.use-tls: true
98+
99+
.. describe:: SERVER_EMAIL
100+
101+
::
102+
103+
mail.from: '[email protected]'
104+
105+
.. describe:: EMAIL_SUBJECT_PREFIX
106+
107+
::
108+
109+
mail.subject-prefix: '[Sentry] '

src/sentry/templates/sentry/admin/status/warnings.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
{% block main %}
1111
<h3>System Warnings</h3>
1212
{% if groups or warnings %}
13+
<p><a href="https://docs.getsentry.com/on-premise/server/warnings/">Check out our guide</a> for more information on how to resolve these issues.</p>
1314
{% for group, items in groups %}
1415
<h4>{{ group }}</h4>
1516
<ul>

0 commit comments

Comments
 (0)