You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

360 lines
23 KiB

  1. <h1>Server Configuration</h1>
  2. <p>Healthchecks prepares its configuration in <code>hc/settings.py</code>. It reads configuration
  3. from environment variables. Below is a list of variables it reads and uses:</p>
  4. <h2 id="ALLOWED_HOSTS"><code>ALLOWED_HOSTS</code></h2>
  5. <p>Default: <code>*</code></p>
  6. <p>A list of strings representing the host/domain names that this site can serve.
  7. You can specify multiple domain names by separating them with commas:</p>
  8. <div class="highlight"><pre><span></span><code><span class="na">ALLOWED_HOSTS</span><span class="o">=</span><span class="s">my-hc.example.org,alternative-name.example.org</span>
  9. </code></pre></div>
  10. <p>Aside from the comma-separated syntax, this is a standard Django setting.
  11. Read more about it in the
  12. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#allowed-hosts">Django documentation</a>.</p>
  13. <h2 id="APPRISE_ENABLED"><code>APPRISE_ENABLED</code></h2>
  14. <p>Default: <code>False</code></p>
  15. <p>A boolean that turns on/off the <a href="https://github.com/caronc/apprise">Apprise</a>
  16. integration.</p>
  17. <p>Before enabling the Apprise integration, make sure the <code>apprise</code> package is installed:</p>
  18. <div class="highlight"><pre><span></span><code>pip install apprise
  19. </code></pre></div>
  20. <h2 id="DB"><code>DB</code></h2>
  21. <p>Default: <code>sqlite</code></p>
  22. <p>The database enginge to use. Possible values: <code>sqlite</code>, <code>postgres</code>, <code>mysql</code>.</p>
  23. <h2 id="DB_CONN_MAX_AGE"><code>DB_CONN_MAX_AGE</code></h2>
  24. <p>Default: <code>0</code></p>
  25. <p>This is a standard Django setting, read more in
  26. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#conn-max-age">Django documentation</a>.</p>
  27. <h2 id="DB_HOST"><code>DB_HOST</code></h2>
  28. <p>Default: <code>""</code> (empty string)</p>
  29. <p>This is a standard Django setting, read more in
  30. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#host">Django documentation</a>.</p>
  31. <h2 id="DB_NAME"><code>DB_NAME</code></h2>
  32. <p>Default: <code>hc</code> (PostgreSQL, MySQL) or <code>/path/to/projectdir/hc.sqlite</code> (SQLite)</p>
  33. <p>This is a standard Django setting, read more in
  34. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#name">Django documentation</a>.</p>
  35. <h2 id="DB_PASSWORD"><code>DB_PASSWORD</code></h2>
  36. <p>Default: <code>""</code> (empty string)</p>
  37. <p>This is a standard Django setting, read more in
  38. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#password">Django documentation</a>.</p>
  39. <h2 id="DB_PORT"><code>DB_PORT</code></h2>
  40. <p>Default: <code>""</code> (empty string)</p>
  41. <p>This is a standard Django setting, read more in
  42. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#port">Django documentation</a>.</p>
  43. <h2 id="DB_SSLMODE"><code>DB_SSLMODE</code></h2>
  44. <p>Default: <code>prefer</code></p>
  45. <p>PostgreSQL-specific, <a href="https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-SSLMODE">details</a></p>
  46. <h2 id="DB_TARGET_SESSION_ATTRS"><code>DB_TARGET_SESSION_ATTRS</code></h2>
  47. <p>Default: <code>read-write</code></p>
  48. <p>PostgreSQL-specific, <a href="https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS">details</a></p>
  49. <h2 id="DB_USER"><code>DB_USER</code></h2>
  50. <p>Default: <code>postgres</code> (PostgreSQL) or <code>root</code> (MySQL)</p>
  51. <p>This is a standard Django setting, read more in
  52. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#user">Django documentation</a>.</p>
  53. <h2 id="DEBUG"><code>DEBUG</code></h2>
  54. <p>Default: <code>True</code></p>
  55. <p>A boolean that turns on/off debug mode.</p>
  56. <p><em>Never run a Healthchecks instance in production with the debug mode turned on!</em></p>
  57. <p>This is a standard Django setting, read more in
  58. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#debug">Django documentation</a>.</p>
  59. <h2 id="DEFAULT_FROM_EMAIL"><code>DEFAULT_FROM_EMAIL</code></h2>
  60. <p>Default: <code>[email protected]</code></p>
  61. <p>This is a standard Django setting, read more in
  62. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#default-from-email">Django documentation</a>.</p>
  63. <h2 id="DISCORD_CLIENT_ID"><code>DISCORD_CLIENT_ID</code></h2>
  64. <p>Default: <code>None</code></p>
  65. <p>The Discord Client ID, required by the Discord integration.</p>
  66. <p>To set up the Discord integration:</p>
  67. <ul>
  68. <li>Register a new application at
  69. <a href="https://discordapp.com/developers/applications/me">https://discordapp.com/developers/applications/me</a></li>
  70. <li>Add a Redirect URI to your Discord application. The URI format is
  71. <code>SITE_ROOT/integrations/add_discord/</code>. For example, if <code>your SITE_ROOT</code>
  72. is <code>https://my-hc.example.org</code> then the Redirect URI would be
  73. <code>https://my-hc.example.org/integrations/add_discord/</code></li>
  74. <li>Look up your Discord app's <em>Client ID</em> and <em>Client Secret</em>. Put them
  75. in the <code>DISCORD_CLIENT_ID</code> and <code>DISCORD_CLIENT_SECRET</code> environment
  76. variables.</li>
  77. </ul>
  78. <h2 id="DISCORD_CLIENT_SECRET"><code>DISCORD_CLIENT_SECRET</code></h2>
  79. <p>Default: <code>None</code></p>
  80. <p>The Discord Client Secret, required by the Discord integration. Look it up at
  81. <a href="https://discordapp.com/developers/applications/me">https://discordapp.com/developers/applications/me</a>.</p>
  82. <h2 id="EMAIL_HOST"><code>EMAIL_HOST</code></h2>
  83. <p>Default: <code>""</code> (empty string)</p>
  84. <p>This is a standard Django setting, read more in
  85. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host">Django documentation</a>.</p>
  86. <h2 id="EMAIL_HOST_PASSWORD"><code>EMAIL_HOST_PASSWORD</code></h2>
  87. <p>Default: <code>""</code> (empty string)</p>
  88. <p>This is a standard Django setting, read more in
  89. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-password">Django documentation</a>.</p>
  90. <h2 id="EMAIL_HOST_USER"><code>EMAIL_HOST_USER</code></h2>
  91. <p>Default: <code>""</code> (empty string)</p>
  92. <p>This is a standard Django setting, read more in
  93. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-user">Django documentation</a>.</p>
  94. <h2 id="EMAIL_PORT"><code>EMAIL_PORT</code></h2>
  95. <p>Default: <code>587</code></p>
  96. <p>This is a standard Django setting, read more in
  97. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-port">Django documentation</a>.</p>
  98. <h2 id="EMAIL_USE_TLS"><code>EMAIL_USE_TLS</code></h2>
  99. <p>Default: <code>True</code></p>
  100. <p>This is a standard Django setting, read more in
  101. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-use-tls">Django documentation</a>.</p>
  102. <h2 id="EMAIL_USE_VERIFICATION"><code>EMAIL_USE_VERIFICATION</code></h2>
  103. <p>Default: <code>True</code></p>
  104. <p>A boolean that turns on/off a verification step when adding an email integration.</p>
  105. <p>If enabled, whenever an user adds an email integration, Healthchecks emails a
  106. verification link to the new address. The new integration becomes active only
  107. after user clicks the verification link.</p>
  108. <p>If you are setting up a private healthchecks instance where
  109. you trust your users, you can opt to disable the verification step. In that case,
  110. set <code>EMAIL_USE_VERIFICATION</code> to <code>False</code>.</p>
  111. <h2 id="LINENOTIFY_CLIENT_ID"><code>LINENOTIFY_CLIENT_ID</code></h2>
  112. <p>Default: <code>None</code></p>
  113. <h2 id="LINENOTIFY_CLIENT_SECRET"><code>LINENOTIFY_CLIENT_SECRET</code></h2>
  114. <p>Default: <code>None</code></p>
  115. <h2 id="MASTER_BADGE_URL"><code>MASTER_BADGE_LABEL</code></h2>
  116. <p>Default: same as <code>SITE_NAME</code></p>
  117. <p>The label for the "Overall Status" status badge.</p>
  118. <h2 id="MATRIX_ACCESS_TOKEN"><code>MATRIX_ACCESS_TOKEN</code></h2>
  119. <p>Default: <code>None</code></p>
  120. <p>The <a href="https://matrix.org/">Matrix</a> bot user's access token, required by the Matrix
  121. integration.</p>
  122. <p>To set up the Matrix integration:</p>
  123. <ul>
  124. <li>Register a bot user (for posting notifications) in your preferred Matrix homeserver.</li>
  125. <li>Use the <a href="https://www.matrix.org/docs/guides/client-server-api#login">Login API call</a>
  126. to retrieve bot user's access token. You can run it as shown in the documentation,
  127. using curl in command shell.</li>
  128. <li>Set the <code>MATRIX_</code> environment variables. Example:</li>
  129. </ul>
  130. <div class="highlight"><pre><span></span><code><span class="na">MATRIX_ACCESS_TOKEN</span><span class="o">=</span><span class="s">[a long string of characters returned by the login call]</span>
  131. <span class="na">MATRIX_HOMESERVER</span><span class="o">=</span><span class="s">https://matrix.org</span>
  132. <span class="na">MATRIX_USER_ID</span><span class="o">=</span><span class="s">@mychecks:matrix.org</span>
  133. </code></pre></div>
  134. <h2 id="MATRIX_HOMESERVER"><code>MATRIX_HOMESERVER</code></h2>
  135. <p>Default: <code>None</code></p>
  136. <p>The Matrix bot's homeserver address, required by the Matrix integration.</p>
  137. <h2 id="MATRIX_USER_ID"><code>MATRIX_USER_ID</code></h2>
  138. <p>Default: <code>None</code></p>
  139. <p>The Matrix bot's user identifier, required by the Matrix integration.</p>
  140. <h2 id="MATTERMOST_ENABLED"><code>MATTERMOST_ENABLED</code></h2>
  141. <p>Default: <code>True</code></p>
  142. <p>A boolean that turns on/off the Mattermost integration. Enabled by default.</p>
  143. <h2 id="MSTEAMS_ENABLED"><code>MSTEAMS_ENABLED</code></h2>
  144. <p>Default: <code>True</code></p>
  145. <p>A boolean that turns on/off the MS Teams integration. Enabled by default.</p>
  146. <h2 id="OPSGENIE_ENABLED"><code>OPSGENIE_ENABLED</code></h2>
  147. <p>Default: <code>True</code></p>
  148. <p>A boolean that turns on/off the Opsgenie integration. Enabled by default.</p>
  149. <h2 id="PAGERTREE_ENABLED"><code>PAGERTREE_ENABLED</code></h2>
  150. <p>Default: <code>True</code></p>
  151. <p>A boolean that turns on/off the PagerTree integration. Enabled by default.</p>
  152. <h2 id="PD_ENABLED"><code>PD_ENABLED</code></h2>
  153. <p>Default: <code>True</code></p>
  154. <p>A boolean that turns on/off the PagerDuty integration. Enabled by default.</p>
  155. <h2 id="PD_VENDOR_KEY"><code>PD_VENDOR_KEY</code></h2>
  156. <p>Default: <code>None</code></p>
  157. <p><a href="https://www.pagerduty.com/">PagerDuty</a> vendor key, used by the PagerDuty integration.</p>
  158. <h2 id="PING_BODY_LIMIT"><code>PING_BODY_LIMIT</code></h2>
  159. <p>Default: <code>10000</code></p>
  160. <p>The upper size limit in bytes for logged ping request bodies.
  161. The default value is 10000 (10 kilobytes). You can adjust the limit or you can remove
  162. the it altogether by setting this value to <code>None</code>.</p>
  163. <h2 id="PING_EMAIL_DOMAIN"><code>PING_EMAIL_DOMAIN</code></h2>
  164. <p>Default: <code>localhost</code></p>
  165. <p>The domain to use for generating ping email addresses. Example:</p>
  166. <div class="highlight"><pre><span></span><code><span class="na">PING_EMAIL_DOMAIN</span><span class="o">=</span><span class="s">ping.my-hc.example.org</span>
  167. </code></pre></div>
  168. <p>In this example, Healthchecks would generate ping email addresses similar
  169. to <code>[email protected]</code>.</p>
  170. <h2 id="PING_ENDPOINT"><code>PING_ENDPOINT</code></h2>
  171. <p>Default: <code>SITE_ROOT</code> + <code>/ping/</code></p>
  172. <p>The base URL to use for generating ping URLs. Example:</p>
  173. <div class="highlight"><pre><span></span><code><span class="na">PING_ENDPOINT</span><span class="o">=</span><span class="s">https://ping.my-hc.example.org</span>
  174. </code></pre></div>
  175. <p>In this example, Healthchecks would generate ping URLs similar
  176. to <code>https://ping.my-hc.example.org/3f1a7317-8e96-437c-a17d-b0d550b51e86</code>.</p>
  177. <h2 id="PROMETHEUS_ENABLED"><code>PROMETHEUS_ENABLED</code></h2>
  178. <p>Default: <code>True</code></p>
  179. <p>A boolean that turns on/off the Prometheus integration. Enabled by default.</p>
  180. <h2 id="PUSHBULLET_CLIENT_ID"><code>PUSHBULLET_CLIENT_ID</code></h2>
  181. <p>Default: <code>None</code></p>
  182. <h2 id="PUSHBULLET_CLIENT_SECRET"><code>PUSHBULLET_CLIENT_SECRET</code></h2>
  183. <p>Default: <code>None</code></p>
  184. <h2 id="PUSHOVER_API_TOKEN"><code>PUSHOVER_API_TOKEN</code></h2>
  185. <p>Default: <code>None</code></p>
  186. <p>The <a href="https://pushover.net/">Pushover</a> API token, required by the Pushover integration.</p>
  187. <p>To enable the Pushover integration:</p>
  188. <ul>
  189. <li>Register a new Pushover application at
  190. <a href="https://pushover.net/apps/build">https://pushover.net/apps/build</a>.</li>
  191. <li>Within the Pushover application configuration, enable subscriptions.
  192. Make sure the subscription type is set to "URL". Also make sure the redirect
  193. URL is configured to point back to the root of the Healthchecks instance
  194. (e.g., <code>https://my-hc.example.org/</code>).</li>
  195. <li>Put the Pushover application's <em>API Token</em> and the <em>Subscription URL</em> in
  196. <code>PUSHOVER_API_TOKEN</code> and <code>PUSHOVER_SUBSCRIPTION_URL</code> environment
  197. variables. The Pushover subscription URL should look similar to
  198. <code>https://pushover.net/subscribe/yourAppName-randomAlphaNumericData</code>.</li>
  199. </ul>
  200. <h2 id="PUSHOVER_EMERGENCY_EXPIRATION"><code>PUSHOVER_EMERGENCY_EXPIRATION</code></h2>
  201. <p>Default: <code>86400</code> (24 hours)</p>
  202. <p>Specifies how many seconds an emergency Pushoover notification
  203. will continue to be retried for.</p>
  204. <p>More information in <a href="https://pushover.net/api#priority">Pushover API documentation</a>.</p>
  205. <h2 id="PUSHOVER_EMERGENCY_RETRY_DELAY"><code>PUSHOVER_EMERGENCY_RETRY_DELAY</code></h2>
  206. <p>Default: <code>300</code> (5 minutes)</p>
  207. <p>Specifies how often (in seconds) the Pushover servers will send the same notification
  208. to the user.</p>
  209. <p>More information in <a href="https://pushover.net/api#priority">Pushover API documentation</a>.</p>
  210. <h2 id="PUSHOVER_SUBSCRIPTION_URL"><code>PUSHOVER_SUBSCRIPTION_URL</code></h2>
  211. <p>Default: <code>None</code></p>
  212. <p>The Pushover Subscription URL, required by the Pushover integration.</p>
  213. <h2 id="REGISTRATION_OPEN"><code>REGISTRATION_OPEN</code></h2>
  214. <p>Default: <code>True</code></p>
  215. <p>A boolean that controls whether site visitors can create new accounts.
  216. Set it to <code>False</code> if you are setting up a private Healthchecks instance, but
  217. it needs to be publicly accessible (so, for example, your cloud services
  218. can send pings to it).</p>
  219. <p>If you close new user registration, you can still selectively invite users
  220. to your team account.</p>
  221. <h2 id="REMOTE_USER_HEADER"><code>REMOTE_USER_HEADER</code></h2>
  222. <p>Default: <code>None</code></p>
  223. <p>Specifies the request header to use for external authentication.</p>
  224. <p>Healthchecks supports external authentication by means of HTTP headers set by
  225. reverse proxies or the WSGI server. This allows you to integrate it into your
  226. existing authentication system (e.g., LDAP or OAuth) via an authenticating proxy. When this option is enabled, <strong>Healtchecks will trust the header's value implicitly</strong>, so it is <strong>very important</strong> to ensure that attackers cannot set the value themselves (and thus impersonate any user). How to do this varies by your chosen proxy, but generally involves configuring it to strip out headers that normalize to the same name as the chosen identity header.</p>
  227. <p>To enable this feature, set the <code>REMOTE_USER_HEADER</code> value to a header you wish to authenticate with. HTTP headers will be prefixed with <code>HTTP_</code> and have any dashes converted to underscores. Headers without that prefix can be set by the WSGI server itself only, which is more secure.</p>
  228. <p>When <code>REMOTE_USER_HEADER</code> is set, Healthchecks will:
  229. - assume the header contains user's email address
  230. - look up and automatically log in the user with a matching email address
  231. - automatically create an user account if it does not exist
  232. - disable the default authentication methods (login link to email, password)</p>
  233. <h2 id="RP_ID"><code>RP_ID</code></h2>
  234. <p>Default: <code>None</code></p>
  235. <p>The <a href="https://www.w3.org/TR/webauthn-2/#relying-party-identifier">Relying Party identifier</a>,
  236. required by the WebAuthn second-factor authentication feature.</p>
  237. <p>Healthchecks optionally supports two-factor authentication using the WebAuthn
  238. standard. To enable WebAuthn support, set the <code>RP_ID</code> setting to a non-null value.
  239. Set its value to your site's domain without scheme and without port. For example,
  240. if your site runs on <code>https://my-hc.example.org</code>, set <code>RP_ID</code> to <code>my-hc.example.org</code>.</p>
  241. <p>Note that WebAuthn requires HTTPS, even if running on localhost. To test WebAuthn
  242. locally with a self-signed certificate, you can use the <code>runsslserver</code> command
  243. from the <code>django-sslserver</code> package.</p>
  244. <h2 id="SECRET_KEY"><code>SECRET_KEY</code></h2>
  245. <p>Default: <code>---</code></p>
  246. <p>A secret key used for cryptographic signing, and should be set to a unique,
  247. unpredictable value.</p>
  248. <p>This is a standard Django setting, read more in
  249. <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#secret-key">Django documentation</a>.</p>
  250. <h2 id="SHELL_ENABLED"><code>SHELL_ENABLED</code></h2>
  251. <p>Default: <code>False</code></p>
  252. <p>A boolean that turns on/off the "Shell Commands" integration.</p>
  253. <p>The "Shell Commands" integration runs user-defined local shell commands when checks
  254. go up or down. This integration is disabled by default, and can be enabled by setting
  255. the <code>SHELL_ENABLED</code> environment variable to <code>True</code>.</p>
  256. <p>Note: be careful when using "Shell Commands" integration, and only enable it when
  257. you fully trust the users of your Healthchecks instance. The commands will be executed
  258. by the <code>manage.py sendalerts</code> process, and will run with its system permissions.</p>
  259. <h2 id="SIGNAL_CLI_ENABLED"><code>SIGNAL_CLI_ENABLED</code></h2>
  260. <p>Default: <code>False</code></p>
  261. <p>A boolean that turns on/off the <a href="https://signal.org/">Signal</a> integration.</p>
  262. <p>Healthchecks uses <a href="https://github.com/AsamK/signal-cli">signal-cli</a> to send Signal
  263. notifications. Healthcecks interacts with signal-cli over DBus.</p>
  264. <p>To enable the Signal integration:</p>
  265. <ul>
  266. <li>Set up and configure signal-cli to listen on DBus system bus
  267. (<a href="https://github.com/AsamK/signal-cli/wiki/DBus-service">instructions</a>).
  268. Make sure you can send test messages from command line, using the <code>dbus-send</code>
  269. example given in the signal-cli instructions.</li>
  270. <li>Set the <code>SIGNAL_CLI_ENABLED</code> environment variable to <code>True</code>.</li>
  271. </ul>
  272. <h2 id="SITE_NAME"><code>SITE_NAME</code></h2>
  273. <p>Default: <code>Mychecks</code></p>
  274. <p>The display name of this Healthchecks instance. Healthchecks uses it throughout
  275. its web UI and documentation.</p>
  276. <h2 id="SITE_ROOT"><code>SITE_ROOT</code></h2>
  277. <p>Default: <code>http://localhost:8000</code></p>
  278. <p>The base URL of this Healthchecks instance. Healthchecks uses <code>SITE_ROOT</code> whenever
  279. it needs to construct absolute URLs.</p>
  280. <h2 id="SLACK_CLIENT_ID"><code>SLACK_CLIENT_ID</code></h2>
  281. <p>Default: <code>None</code></p>
  282. <p>The Slack Client ID, used by the Slack integration.</p>
  283. <p>The Slack integration can work with or without the Slack Client ID. If
  284. the Slack Client ID is not set, in the "Integrations - Add Slack" page,
  285. Healthchecks will ask the user to provide a webhook URL for posting notifications.</p>
  286. <p>If the Slack Client <em>is</em> set, Healthchecks will use the OAuth2 flow
  287. to get the webhook URL from Slack. The OAuth2 flow is more user-friendly.
  288. To set it up, go to <a href="https://api.slack.com/apps/">https://api.slack.com/apps/</a>
  289. and create a <em>Slack app</em>. When setting up the Slack app, make sure to:</p>
  290. <ul>
  291. <li>Add the <a href="https://api.slack.com/scopes/incoming-webhook">incoming-webhook</a>
  292. scope to the Bot Token Scopes.</li>
  293. <li>Add a <em>Redirect URL</em> in the format <code>SITE_ROOT/integrations/add_slack_btn/</code>.
  294. For example, if your <code>SITE_ROOT</code> is <code>https://my-hc.example.org</code> then the
  295. Redirect URL would be <code>https://my-hc.example.org/integrations/add_slack_btn/</code>.</li>
  296. </ul>
  297. <h2 id="SLACK_CLIENT_SECRET"><code>SLACK_CLIENT_SECRET</code></h2>
  298. <p>Default: <code>None</code></p>
  299. <p>The Slack Client Secret. Required if <code>SLACK_CLIENT_ID</code> is set.
  300. Look it up at <a href="https://api.slack.com/apps/">https://api.slack.com/apps/</a>.</p>
  301. <h2 id="SLACK_ENABLED"><code>SLACK_ENABLED</code></h2>
  302. <p>Default: <code>True</code></p>
  303. <p>A boolean that turns on/off the Slack integration. Enabled by default.</p>
  304. <h2 id="SPIKE_ENABLED"><code>SPIKE_ENABLED</code></h2>
  305. <p>Default: <code>True</code></p>
  306. <p>A boolean that turns on/off the Spike.sh integration. Enabled by default.</p>
  307. <h2 id="TELEGRAM_BOT_NAME"><code>TELEGRAM_BOT_NAME</code></h2>
  308. <p>Default: <code>ExampleBot</code></p>
  309. <p>The <a href="https://telegram.org/">Telegram</a> bot name, required by the Telegram integration.</p>
  310. <p>To set up the Telegram integration:</p>
  311. <ul>
  312. <li>Create a Telegram bot by talking to the
  313. <a href="https://core.telegram.org/bots#6-botfather">BotFather</a>. Set the bot's name,
  314. description, user picture, and add a "/start" command.</li>
  315. <li>After creating the bot you will have the bot's name and token. Put them
  316. in <code>TELEGRAM_BOT_NAME</code> and <code>TELEGRAM_TOKEN</code> environment variables.</li>
  317. <li>Run the <code>settelegramwebhook</code> management command. This command tells Telegram
  318. where to forward channel messages by invoking Telegram's
  319. <a href="https://core.telegram.org/bots/api#setwebhook">setWebhook</a> API call:</li>
  320. </ul>
  321. <div class="highlight"><pre><span></span><code>$ ./manage.py settelegramwebhook
  322. Done, Telegram<span class="err">&#39;</span>s webhook <span class="nb">set</span> to: https://my-monitoring-project.com/integrations/telegram/bot/
  323. </code></pre></div>
  324. <p>For this to work, your <code>SITE_ROOT</code> must be publicy accessible and use the "https://"
  325. scheme.</p>
  326. <h2 id="TELEGRAM_TOKEN"><code>TELEGRAM_TOKEN</code></h2>
  327. <p>Default: <code>None</code></p>
  328. <p>The Telegram bot user's authentication token, required by the Telegram integration.</p>
  329. <h2 id="TRELLO_APP_KEY"><code>TRELLO_APP_KEY</code></h2>
  330. <p>Default: <code>None</code></p>
  331. <p>The <a href="https://trello.com/">Trello</a> app key, required by the Trello integration.</p>
  332. <p>To set up the Trello integration, get a developer API key from
  333. <a href="https://trello.com/app-key">https://trello.com/app-key</a> and put it in the
  334. <code>TRELLO_APP_KEY</code> environment variable.</p>
  335. <h2 id="TWILIO_ACCOUNT"><code>TWILIO_ACCOUNT</code></h2>
  336. <p>Default: <code>None</code></p>
  337. <h2 id="TWILIO_AUTH"><code>TWILIO_AUTH</code></h2>
  338. <p>Default: <code>None</code></p>
  339. <h2 id="TWILIO_FROM"><code>TWILIO_FROM</code></h2>
  340. <p>Default: <code>None</code></p>
  341. <h2 id="TWILIO_USE_WHATSAPP"><code>TWILIO_USE_WHATSAPP</code></h2>
  342. <p>Default: <code>False</code></p>
  343. <h2 id="USE_PAYMENTS"><code>USE_PAYMENTS</code></h2>
  344. <p>Default: <code>False</code></p>
  345. <p>A boolean that turns on/off billing features.</p>
  346. <h2 id="VICTOROPS_ENABLED"><code>VICTOROPS_ENABLED</code></h2>
  347. <p>Default: <code>True</code></p>
  348. <p>A boolean that turns on/off the Splunk On-Call (VictorOps) integration.
  349. Enabled by default.</p>
  350. <h2 id="WEBHOOKS_ENABLED"><code>WEBHOOKS_ENABLED</code></h2>
  351. <p>Default: <code>True</code></p>
  352. <p>A boolean that turns on/off the Webhooks integration. Enabled by default.</p>
  353. <h2 id="ZULIP_ENABLED"><code>ZULIP_ENABLED</code></h2>
  354. <p>Default: <code>True</code></p>
  355. <p>A boolean that turns on/off the Zulip integration. Enabled by default.</p>