Pēteris Caune
4 years ago
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
25 changed files with 1034 additions and 139 deletions
Unified View
Diff Options
-
+1 -0CHANGELOG.md
-
+16 -14hc/front/views.py
-
+1 -1hc/settings.py
-
+22 -43templates/docs/api.html
-
+4 -8templates/docs/attaching_logs.html
-
+4 -7templates/docs/bash.html
-
+1 -1templates/docs/cloning_checks.html
-
+1 -2templates/docs/configuring_prometheus.html
-
+1 -1templates/docs/csharp.html
-
+1 -1templates/docs/go.html
-
+12 -23templates/docs/http_api.html
-
+2 -3templates/docs/javascript.html
-
+1 -2templates/docs/measuring_script_run_time.html
-
+5 -9templates/docs/monitoring_cron_jobs.html
-
+2 -4templates/docs/php.html
-
+3 -5templates/docs/powershell.html
-
+3 -5templates/docs/python.html
-
+2 -4templates/docs/reliability_tips.html
-
+1 -1templates/docs/ruby.html
-
+86 -0templates/docs/self_hosted.html
-
+81 -0templates/docs/self_hosted.md
-
+301 -0templates/docs/self_hosted_configuration.html
-
+476 -0templates/docs/self_hosted_configuration.md
-
+3 -5templates/docs/signaling_failures.html
-
+4 -0templates/front/base_docs.html
+ 1
- 0
CHANGELOG.md
View File
+ 16
- 14
hc/front/views.py
View File
+ 1
- 1
hc/settings.py
View File
+ 22
- 43
templates/docs/api.html
View File
+ 4
- 8
templates/docs/attaching_logs.html
View File
+ 4
- 7
templates/docs/bash.html
View File
+ 1
- 1
templates/docs/cloning_checks.html
View File
+ 1
- 2
templates/docs/configuring_prometheus.html
View File
+ 1
- 1
templates/docs/csharp.html
View File
| @ -1,6 +1,6 @@ | |||||
| <h1>C#</h1> | <h1>C#</h1> | ||||
| <p>Below is an example of making an HTTP request to SITE_NAME from C#.</p> | <p>Below is an example of making an HTTP request to SITE_NAME from C#.</p> | ||||
| <div class="csharp highlight"><pre><span></span><code><span class="k">using</span> <span class="p">(</span><span class="kt">var</span> <span class="n">client</span> <span class="p">=</span> <span class="k">new</span> <span class="n">System</span><span class="p">.</span><span class="n">Net</span><span class="p">.</span><span class="n">WebClient</span><span class="p">())</span> | |||||
| <div class="highlight"><pre><span></span><code><span class="k">using</span> <span class="p">(</span><span class="kt">var</span> <span class="n">client</span> <span class="p">=</span> <span class="k">new</span> <span class="n">System</span><span class="p">.</span><span class="n">Net</span><span class="p">.</span><span class="n">WebClient</span><span class="p">())</span> | |||||
| <span class="p">{</span> | <span class="p">{</span> | ||||
| <span class="n">client</span><span class="p">.</span><span class="n">DownloadString</span><span class="p">(</span><span class="s">"PING_URL"</span><span class="p">);</span> | <span class="n">client</span><span class="p">.</span><span class="n">DownloadString</span><span class="p">(</span><span class="s">"PING_URL"</span><span class="p">);</span> | ||||
| <span class="p">}</span> | <span class="p">}</span> | ||||
+ 1
- 1
templates/docs/go.html
View File
+ 12
- 23
templates/docs/http_api.html
View File
+ 2
- 3
templates/docs/javascript.html
View File
| @ -1,15 +1,14 @@ | |||||
| <h1>Javascript</h1> | <h1>Javascript</h1> | ||||
| <p>Below is an example of making an HTTP request to SITE_NAME from Node.js.</p> | <p>Below is an example of making an HTTP request to SITE_NAME from Node.js.</p> | ||||
| <div class="js highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">https</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'https'</span><span class="p">);</span> | |||||
| <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">https</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'https'</span><span class="p">);</span> | |||||
| <span class="nx">https</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s1">'PING_URL'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span> | <span class="nx">https</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s1">'PING_URL'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span> | ||||
| <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Ping failed: '</span> <span class="o">+</span> <span class="nx">err</span><span class="p">)</span> | <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Ping failed: '</span> <span class="o">+</span> <span class="nx">err</span><span class="p">)</span> | ||||
| <span class="p">});</span> | <span class="p">});</span> | ||||
| </code></pre></div> | </code></pre></div> | ||||
| <p>You can also send pings from a browser environment. SITE_NAME sets the | <p>You can also send pings from a browser environment. SITE_NAME sets the | ||||
| <code>Access-Control-Allow-Origin:*</code> CORS header, so cross-domain AJAX requests work.</p> | <code>Access-Control-Allow-Origin:*</code> CORS header, so cross-domain AJAX requests work.</p> | ||||
| <div class="js highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">xhr</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">XMLHttpRequest</span><span class="p">();</span> | |||||
| <div class="highlight"><pre><span></span><code><span class="kd">var</span> <span class="nx">xhr</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">XMLHttpRequest</span><span class="p">();</span> | |||||
| <span class="nx">xhr</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="s1">'GET'</span><span class="p">,</span> <span class="s1">'PING_URL'</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span> | <span class="nx">xhr</span><span class="p">.</span><span class="nx">open</span><span class="p">(</span><span class="s1">'GET'</span><span class="p">,</span> <span class="s1">'PING_URL'</span><span class="p">,</span> <span class="kc">true</span><span class="p">);</span> | ||||
| <span class="nx">xhr</span><span class="p">.</span><span class="nx">send</span><span class="p">(</span><span class="kc">null</span><span class="p">);</span> | <span class="nx">xhr</span><span class="p">.</span><span class="nx">send</span><span class="p">(</span><span class="kc">null</span><span class="p">);</span> | ||||
| </code></pre></div> | </code></pre></div> | ||||
+ 1
- 2
templates/docs/measuring_script_run_time.html
View File
+ 5
- 9
templates/docs/monitoring_cron_jobs.html
View File
+ 2
- 4
templates/docs/php.html
View File
+ 3
- 5
templates/docs/powershell.html
View File
+ 3
- 5
templates/docs/python.html
View File
+ 2
- 4
templates/docs/reliability_tips.html
View File
+ 1
- 1
templates/docs/ruby.html
View File
| @ -1,6 +1,6 @@ | |||||
| <h1>Ruby</h1> | <h1>Ruby</h1> | ||||
| <p>Below is an example of making an HTTP request to SITE_NAME from Ruby.</p> | <p>Below is an example of making an HTTP request to SITE_NAME from Ruby.</p> | ||||
| <div class="ruby highlight"><pre><span></span><code><span class="nb">require</span> <span class="s1">'net/http'</span> | |||||
| <div class="highlight"><pre><span></span><code><span class="nb">require</span> <span class="s1">'net/http'</span> | |||||
| <span class="nb">require</span> <span class="s1">'uri'</span> | <span class="nb">require</span> <span class="s1">'uri'</span> | ||||
| <span class="no">Net</span><span class="o">::</span><span class="no">HTTP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="no">URI</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s1">'PING_URL'</span><span class="p">))</span> | <span class="no">Net</span><span class="o">::</span><span class="no">HTTP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="no">URI</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s1">'PING_URL'</span><span class="p">))</span> | ||||
+ 86
- 0
templates/docs/self_hosted.html
View File
| @ -0,0 +1,86 @@ | |||||
| <h1>Self-Hosted Healthchecks</h1> | |||||
| <p>Healthchecks is open-source, and is licensed under the BSD 3-clause license.</p> | |||||
| <p>Rather than using the hosted service at | |||||
| <a href="https://healthchecks.io">https://healthchecks.io</a>, you have the option to host an | |||||
| instance yourself.</p> | |||||
| <p>The building blocks are:</p> | |||||
| <ul> | |||||
| <li>Python 3.6+</li> | |||||
| <li>Django 3</li> | |||||
| <li>PostgreSQL or MySQL</li> | |||||
| </ul> | |||||
| <h2>Setting Up for Development</h2> | |||||
| <p>You can set up a development environment in a Python | |||||
| <a href="https://docs.python.org/3/tutorial/venv.html">virtual environment</a> | |||||
| on your local system to develop a new feature, write a new integration | |||||
| or test a bugfix.</p> | |||||
| <p>The following instructions assume you are using a Debian-based OS.</p> | |||||
| <ul> | |||||
| <li> | |||||
| <p>Install dependencies:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ sudo apt-get update | |||||
| $ sudo apt-get install -y gcc python3-dev python3-venv | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Prepare directory for project code and virtualenv. Feel free to use a | |||||
| different location:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ mkdir -p ~/webapps | |||||
| $ <span class="nb">cd</span> ~/webapps | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Prepare virtual environment | |||||
| (with virtualenv you get pip, we'll use it soon to install requirements):</p> | |||||
| <div class="highlight"><pre><span></span><code>$ python3 -m venv hc-venv | |||||
| $ <span class="nb">source</span> hc-venv/bin/activate | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Check out project code:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ git clone https://github.com/healthchecks/healthchecks.git | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Install requirements (Django, ...) into virtualenv:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ pip install wheel | |||||
| $ pip install -r healthchecks/requirements.txt | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Create database tables and a superuser account:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ <span class="nb">cd</span> ~/webapps/healthchecks | |||||
| $ ./manage.py migrate | |||||
| $ ./manage.py createsuperuser | |||||
| </code></pre></div> | |||||
| </li> | |||||
| </ul> | |||||
| <p>With the default configuration, Healthchecks stores data in a SQLite file | |||||
| <code>hc.sqlite</code> in the checkout directory (<code>~/webapps/healthchecks</code>).</p> | |||||
| <ul> | |||||
| <li> | |||||
| <p>Run tests:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ ./manage.py <span class="nb">test</span> | |||||
| </code></pre></div> | |||||
| </li> | |||||
| <li> | |||||
| <p>Run development server:</p> | |||||
| <div class="highlight"><pre><span></span><code>$ ./manage.py runserver | |||||
| </code></pre></div> | |||||
| </li> | |||||
| </ul> | |||||
| <p>At this point, the site should now be running at <code>http://localhost:8000</code>.</p> | |||||
| <p>To access Django administration site, log in as a superuser, then | |||||
| visit <code>http://localhost:8000/admin/</code>.</p> | |||||
| <p>FIXME note about no email configuration, no sendalerts, and the devserver</p> | |||||
| <h2>Next Steps</h2> | |||||
| <p>Get the <a href="https://github.com/healthchecks/healthchecks">source code</a>.</p> | |||||
| <p>See <a href="../self_hosted_configuration/">Configuration</a> for a list of configuration options.</p> | |||||
+ 81
- 0
templates/docs/self_hosted.md
View File
| @ -0,0 +1,81 @@ | |||||
| # Self-Hosted Healthchecks | |||||
| Healthchecks is open-source, and is licensed under the BSD 3-clause license. | |||||
| Rather than using the hosted service at | |||||
| [https://healthchecks.io](https://healthchecks.io), you have the option to host an | |||||
| instance yourself. | |||||
| The building blocks are: | |||||
| * Python 3.6+ | |||||
| * Django 3 | |||||
| * PostgreSQL or MySQL | |||||
| ## Setting Up for Development | |||||
| You can set up a development environment in a Python | |||||
| [virtual environment](https://docs.python.org/3/tutorial/venv.html) | |||||
| on your local system to develop a new feature, write a new integration | |||||
| or test a bugfix. | |||||
| The following instructions assume you are using a Debian-based OS. | |||||
| * Install dependencies: | |||||
| $ sudo apt-get update | |||||
| $ sudo apt-get install -y gcc python3-dev python3-venv | |||||
| * Prepare directory for project code and virtualenv. Feel free to use a | |||||
| different location: | |||||
| $ mkdir -p ~/webapps | |||||
| $ cd ~/webapps | |||||
| * Prepare virtual environment | |||||
| (with virtualenv you get pip, we'll use it soon to install requirements): | |||||
| $ python3 -m venv hc-venv | |||||
| $ source hc-venv/bin/activate | |||||
| * Check out project code: | |||||
| $ git clone https://github.com/healthchecks/healthchecks.git | |||||
| * Install requirements (Django, ...) into virtualenv: | |||||
| $ pip install wheel | |||||
| $ pip install -r healthchecks/requirements.txt | |||||
| * Create database tables and a superuser account: | |||||
| $ cd ~/webapps/healthchecks | |||||
| $ ./manage.py migrate | |||||
| $ ./manage.py createsuperuser | |||||
| With the default configuration, Healthchecks stores data in a SQLite file | |||||
| `hc.sqlite` in the checkout directory (`~/webapps/healthchecks`). | |||||
| * Run tests: | |||||
| $ ./manage.py test | |||||
| * Run development server: | |||||
| $ ./manage.py runserver | |||||
| At this point, the site should now be running at `http://localhost:8000`. | |||||
| To access Django administration site, log in as a superuser, then | |||||
| visit `http://localhost:8000/admin/`. | |||||
| FIXME note about no email configuration, no sendalerts, and the devserver | |||||
| ## Next Steps | |||||
| Get the [source code](https://github.com/healthchecks/healthchecks). | |||||
| See [Configuration](../self_hosted_configuration/) for a list of configuration options. | |||||
+ 301
- 0
templates/docs/self_hosted_configuration.html
View File
| @ -0,0 +1,301 @@ | |||||
| <h1>Server Configuration</h1> | |||||
| <p>Healthchecks prepares its configuration in <code>hc/settings.py</code>. It reads configuration | |||||
| from environment variables. Below is a list of variables it reads and uses:</p> | |||||
| <h2><code>ALLOWED_HOSTS</code></h2> | |||||
| <p>Default: <code>*</code></p> | |||||
| <p>A list of strings representing the host/domain names that this site can serve. | |||||
| You can specify multiple domain names by separating them with commas:</p> | |||||
| <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> | |||||
| </code></pre></div> | |||||
| <p>Aside from the comma-separated syntax, this is a standard Django setting. | |||||
| Read more about it in the | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#allowed-hosts">Django documentation</a>.</p> | |||||
| <h2><code>APPRISE_ENABLED</code></h2> | |||||
| <p>Default: <code>False</code></p> | |||||
| <p>A boolean that turns on/off the <a href="https://github.com/caronc/apprise">Apprise</a> | |||||
| integration.</p> | |||||
| <p>Before enabling the Apprise integration, make sure the <code>apprise</code> package is installed:</p> | |||||
| <div class="highlight"><pre><span></span><code>pip install apprise | |||||
| </code></pre></div> | |||||
| <h2><code>DEBUG</code></h2> | |||||
| <p>Default: <code>True</code></p> | |||||
| <p>A boolean that turns on/off debug mode.</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#debug">Django documentation</a>.</p> | |||||
| <h2><code>DEFAULT_FROM_EMAIL</code></h2> | |||||
| <p>Default: <code>[email protected]</code></p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#default-from-email">Django documentation</a>.</p> | |||||
| <h2><code>DB</code></h2> | |||||
| <p>Default: <code>sqlite</code></p> | |||||
| <p>The database enginge to use. Possible values: <code>sqlite</code>, <code>postgres</code>, <code>mysql</code>.</p> | |||||
| <h2><code>DB_CONN_MAX_AGE</code></h2> | |||||
| <p>Default: <code>0</code></p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#conn-max-age">Django documentation</a>.</p> | |||||
| <h2><code>DB_HOST</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#host">Django documentation</a>.</p> | |||||
| <h2><code>DB_NAME</code></h2> | |||||
| <p>Default: <code>hc</code> (PostgreSQL, MySQL) or <code>{project-path}/hc.sqlite</code> (SQLite)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#name">Django documentation</a>.</p> | |||||
| <h2><code>DB_PASSWORD</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#password">Django documentation</a>.</p> | |||||
| <h2><code>DB_PORT</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#port">Django documentation</a>.</p> | |||||
| <h2><code>DB_SSLMODE</code></h2> | |||||
| <p>Default: <code>prefer</code></p> | |||||
| <p>PostgreSQL-specific, <a href="https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-SSLMODE">details</a></p> | |||||
| <h2><code>DB_TARGET_SESSION_ATTRS</code></h2> | |||||
| <p>Default: <code>read-write</code></p> | |||||
| <p>PostgreSQL-specific, <a href="https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS">details</a></p> | |||||
| <h2><code>DB_USER</code></h2> | |||||
| <p>Default: <code>postgres</code> (PostgreSQL) or <code>root</code> (MySQL)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#user">Django documentation</a>.</p> | |||||
| <h2><code>DISCORD_CLIENT_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Discord Client ID, required by the Discord integration.</p> | |||||
| <p>To set up the Discord integration:</p> | |||||
| <ul> | |||||
| <li>Register a new application at | |||||
| <a href="https://discordapp.com/developers/applications/me">https://discordapp.com/developers/applications/me</a></li> | |||||
| <li>Add a Redirect URI to your Discord application. The URI format is | |||||
| <code>SITE_ROOT/integrations/add_discord/</code>. For example, if <code>your SITE_ROOT</code> | |||||
| is <code>https://my-hc.example.org</code> then the Redirect URI would be | |||||
| <code>https://my-hc.example.org/integrations/add_discord/</code></li> | |||||
| <li>Look up your Discord app's <em>Client ID</em> and <em>Client Secret</em>. Put them | |||||
| in the <code>DISCORD_CLIENT_ID</code> and <code>DISCORD_CLIENT_SECRET</code> environment | |||||
| variables.</li> | |||||
| </ul> | |||||
| <h2><code>DISCORD_CLIENT_SECRET</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Discord Client Secret, required by the Slack integration. Look it up at | |||||
| <a href="https://discordapp.com/developers/applications/me">https://discordapp.com/developers/applications/me</a>.</p> | |||||
| <h2><code>EMAIL_HOST</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host">Django documentation</a>.</p> | |||||
| <h2><code>EMAIL_HOST_PASSWORD</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-password">Django documentation</a>.</p> | |||||
| <h2><code>EMAIL_HOST_USER</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-user">Django documentation</a>.</p> | |||||
| <h2><code>EMAIL_PORT</code></h2> | |||||
| <p>Default: <code>587</code></p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-port">Django documentation</a>.</p> | |||||
| <h2><code>EMAIL_USE_TLS</code></h2> | |||||
| <p>Default: <code>True</code></p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#email-use-tls">Django documentation</a>.</p> | |||||
| <h2><code>EMAIL_USE_VERIFICATION</code></h2> | |||||
| <p>Default: <code>True</code></p> | |||||
| <p>A boolean that turns on/off a verification step when adding an email integration.</p> | |||||
| <p>If enabled, whenever an user adds an email integration, Healthchecks emails a | |||||
| verification link to the new address. The new integration becomes active only | |||||
| after user clicks the verification link.</p> | |||||
| <p>If you are setting up a private healthchecks instance where | |||||
| you trust your users, you can opt to disable the verification step. In that case, | |||||
| set <code>EMAIL_USE_VERIFICATION</code> to <code>False</code>.</p> | |||||
| <h2><code>LINENOTIFY_CLIENT_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>LINENOTIFY_CLIENT_SECRET</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>MASTER_BADGE_LABEL</code></h2> | |||||
| <p>Default: same as <code>SITE_NAME</code></p> | |||||
| <h2><code>MATRIX_ACCESS_TOKEN</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The <a href="https://matrix.org/">Matrix</a> bot user's access token, required by the Matrix | |||||
| integration.</p> | |||||
| <p>To set up the Matrix integration:</p> | |||||
| <ul> | |||||
| <li>Register a bot user (for posting notifications) in your preferred Matrix homeserver.</li> | |||||
| <li>Use the <a href="https://www.matrix.org/docs/guides/client-server-api#login">Login API call</a> | |||||
| to retrieve bot user's access token. You can run it as shown in the documentation, | |||||
| using curl in command shell.</li> | |||||
| <li>Set the <code>MATRIX_</code> environment variables. Example:</li> | |||||
| </ul> | |||||
| <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> | |||||
| <span class="na">MATRIX_HOMESERVER</span><span class="o">=</span><span class="s">https://matrix.org</span> | |||||
| <span class="na">MATRIX_USER_ID</span><span class="o">=</span><span class="s">@mychecks:matrix.org</span> | |||||
| </code></pre></div> | |||||
| <h2><code>MATRIX_HOMESERVER</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Matrix bot's homeserver address, required by the Matrix integration.</p> | |||||
| <h2><code>MATRIX_USER_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Matrix bot's user identifier, required by the Matrix integration.</p> | |||||
| <h2><code>PD_VENDOR_KEY</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p><a href="https://www.pagerduty.com/">PagerDuty</a> vendor key, | |||||
| required by the PagerDuty integration.</p> | |||||
| <h2><code>PING_BODY_LIMIT</code></h2> | |||||
| <p>Default: <code>10000</code></p> | |||||
| <p>The upper size limit in bytes for logged ping request bodies. | |||||
| The default value is 10000 (10 kilobytes). You can adjust the limit or you can remove | |||||
| the it altogether by setting this value to <code>None</code>.</p> | |||||
| <h2><code>PING_EMAIL_DOMAIN</code></h2> | |||||
| <p>Default: <code>localhost</code></p> | |||||
| <h2><code>PING_ENDPOINT</code></h2> | |||||
| <p>Default: <code>http://localhost:8000/ping/</code></p> | |||||
| <h2><code>PUSHBULLET_CLIENT_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>PUSHBULLET_CLIENT_SECRET</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>PUSHOVER_API_TOKEN</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The <a href="https://pushover.net/">Pushover</a> API token, required by the Pushover integration.</p> | |||||
| <p>To enable the Pushover integration:</p> | |||||
| <ul> | |||||
| <li>Register a new Pushover application at | |||||
| <a href="https://pushover.net/apps/build">https://pushover.net/apps/build</a>.</li> | |||||
| <li>Within the Pushover application configuration, enable subscriptions. | |||||
| Make sure the subscription type is set to "URL". Also make sure the redirect | |||||
| URL is configured to point back to the root of the Healthchecks instance | |||||
| (e.g., <code>https://my-hc.example.org/</code>).</li> | |||||
| <li>Put the Pushover application's <em>API Token</em> and the <em>Subscription URL</em> in | |||||
| <code>PUSHOVER_API_TOKEN</code> and <code>PUSHOVER_SUBSCRIPTION_URL</code> environment | |||||
| variables. The Pushover subscription URL should look similar to | |||||
| <code>https://pushover.net/subscribe/yourAppName-randomAlphaNumericData</code>.</li> | |||||
| </ul> | |||||
| <h2><code>PUSHOVER_EMERGENCY_EXPIRATION</code></h2> | |||||
| <p>Default: <code>86400</code> (24 hours)</p> | |||||
| <p>Specifies how many seconds an emergency Pushoover notification | |||||
| will continue to be retried for.</p> | |||||
| <p>More information in <a href="https://pushover.net/api#priority">Pushover API documentation</a>.</p> | |||||
| <h2><code>PUSHOVER_EMERGENCY_RETRY_DELAY</code></h2> | |||||
| <p>Default: <code>300</code> (5 minutes)</p> | |||||
| <p>Specifies how often (in seconds) the Pushover servers will send the same notification | |||||
| to the user.</p> | |||||
| <p>More information in <a href="https://pushover.net/api#priority">Pushover API documentation</a>.</p> | |||||
| <h2><code>PUSHOVER_SUBSCRIPTION_URL</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Pushover Subscription URL, required by the Pushover integration.</p> | |||||
| <h2><code>REGISTRATION_OPEN</code></h2> | |||||
| <p>Default: <code>True</code></p> | |||||
| <p>A boolean that controls whether site visitors can create new accounts. | |||||
| Set it to <code>False</code> if you are setting up a private Healthchecks instance, but | |||||
| it needs to be publicly accessible (so, for example, your cloud services | |||||
| can send pings to it).</p> | |||||
| <p>If you close new user registration, you can still selectively invite users | |||||
| to your team account.</p> | |||||
| <h2><code>REMOTE_USER_HEADER</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>Specifies the request header to use for external authentication.</p> | |||||
| <p>Healthchecks supports external authentication by means of HTTP headers set by | |||||
| reverse proxies or the WSGI server. This allows you to integrate it into your | |||||
| 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> | |||||
| <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> | |||||
| <p>When <code>REMOTE_USER_HEADER</code> is set, Healthchecks will: | |||||
| - assume the header contains user's email address | |||||
| - look up and automatically log in the user with a matching email address | |||||
| - automatically create an user account if it does not exist | |||||
| - disable the default authentication methods (login link to email, password)</p> | |||||
| <h2><code>RP_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The <a href="https://www.w3.org/TR/webauthn-2/#relying-party-identifier">Relying Party identifier</a>, | |||||
| required by the WebAuthn second-factor authentication feature.</p> | |||||
| <p>Healthchecks optionally supports two-factor authentication using the WebAuthn | |||||
| standard. To enable WebAuthn support, set the <code>RP_ID</code> setting to a non-null value. | |||||
| Set its value to your site's domain without scheme and without port. For example, | |||||
| 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> | |||||
| <p>Note that WebAuthn requires HTTPS, even if running on localhost. To test WebAuthn | |||||
| locally with a self-signed certificate, you can use the <code>runsslserver</code> command | |||||
| from the <code>django-sslserver</code> package.</p> | |||||
| <h2><code>SECRET_KEY</code></h2> | |||||
| <p>Default: <code>""</code> (empty string)</p> | |||||
| <p>A secret key used for cryptographic signing.</p> | |||||
| <p>This is a standard Django setting, read more in | |||||
| <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#secret-key">Django documentation</a>.</p> | |||||
| <h2><code>SHELL_ENABLED</code></h2> | |||||
| <p>Default: <code>False</code></p> | |||||
| <p>A boolean that turns on/off the "Shell Commands" integration.</p> | |||||
| <p>The "Shell Commands" integration runs user-defined local shell commands when checks | |||||
| go up or down. This integration is disabled by default, and can be enabled by setting | |||||
| the <code>SHELL_ENABLED</code> environment variable to <code>True</code>.</p> | |||||
| <p>Note: be careful when using "Shell Commands" integration, and only enable it when | |||||
| you fully trust the users of your Healthchecks instance. The commands will be executed | |||||
| by the <code>manage.py sendalerts</code> process, and will run with its system permissions.</p> | |||||
| <h2><code>SIGNAL_CLI_ENABLED</code></h2> | |||||
| <p>Default: <code>False</code></p> | |||||
| <p>A boolean that turns on/off the <a href="https://signal.org/">Signal</a> integration.</p> | |||||
| <p>Healthchecks uses <a href="https://github.com/AsamK/signal-cli">signal-cli</a> to send Signal | |||||
| notifications. Healthcecks interacts with signal-cli over DBus.</p> | |||||
| <p>To enable the Signal integration:</p> | |||||
| <ul> | |||||
| <li>Set up and configure signal-cli to listen on DBus system bus | |||||
| (<a href="https://github.com/AsamK/signal-cli/wiki/DBus-service">instructions</a>). | |||||
| Make sure you can send test messages from command line, using the <code>dbus-send</code> | |||||
| example given in the signal-cli instructions.</li> | |||||
| <li>Set the <code>SIGNAL_CLI_ENABLED</code> environment variable to <code>True</code>.</li> | |||||
| </ul> | |||||
| <h2><code>SITE_ROOT</code></h2> | |||||
| <p>Default: <code>http://localhost:8000</code></p> | |||||
| <h2><code>SITE_NAME</code></h2> | |||||
| <p>Default: <code>Mychecks</code></p> | |||||
| <h2><code>SLACK_CLIENT_ID</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Slack Client ID, required by the Slack integration.</p> | |||||
| <p>Go to <a href="https://api.slack.com/apps/">https://api.slack.com/apps/</a> | |||||
| to create a <em>Slack app</em>, and look up its <em>Client ID</em> and <em>Client Secret</em>.</p> | |||||
| <p>When setting up the Slack app, make sure to:</p> | |||||
| <ul> | |||||
| <li>Add the <a href="https://api.slack.com/scopes/incoming-webhook">incoming-webhook</a> | |||||
| scope to the Bot Token Scopes.</li> | |||||
| <li>Add a <em>Redirect URL</em> in the format <code>SITE_ROOT/integrations/add_slack_btn/</code>. | |||||
| For example, if your <code>SITE_ROOT</code> is <code>https://my-hc.example.org</code> then the | |||||
| Redirect URL would be <code>https://my-hc.example.org/integrations/add_slack_btn/</code>.</li> | |||||
| </ul> | |||||
| <h2><code>SLACK_CLIENT_SECRET</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Slack Client Secret, required by the Slack integration. | |||||
| Look it up at <a href="https://api.slack.com/apps/">https://api.slack.com/apps/</a>.</p> | |||||
| <h2><code>TELEGRAM_BOT_NAME</code></h2> | |||||
| <p>Default: <code>ExampleBot</code></p> | |||||
| <p>The <a href="https://telegram.org/">Telegram</a> bot name, required by the Telegram integration.</p> | |||||
| <p>To set up the Telegram integration:</p> | |||||
| <ul> | |||||
| <li>Create a Telegram bot by talking to the | |||||
| <a href="https://core.telegram.org/bots#6-botfather">BotFather</a>. Set the bot's name, | |||||
| description, user picture, and add a "/start" command.</li> | |||||
| <li>After creating the bot you will have the bot's name and token. Put them | |||||
| in <code>TELEGRAM_BOT_NAME</code> and <code>TELEGRAM_TOKEN</code> environment variables.</li> | |||||
| <li>Run the <code>settelegramwebhook</code> management command. This command tells Telegram | |||||
| where to forward channel messages by invoking Telegram's | |||||
| <a href="https://core.telegram.org/bots/api#setwebhook">setWebhook</a> API call:</li> | |||||
| </ul> | |||||
| <div class="highlight"><pre><span></span><code>$ ./manage.py settelegramwebhook | |||||
| Done, Telegram<span class="err">'</span>s webhook <span class="nb">set</span> to: https://my-monitoring-project.com/integrations/telegram/bot/ | |||||
| </code></pre></div> | |||||
| <p>For this to work, your <code>SITE_ROOT</code> must be publicy accessible and use the "https://" | |||||
| scheme.</p> | |||||
| <h2><code>TELEGRAM_TOKEN</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <p>The Telegram bot user's authentication token, required by the Telegram integration.</p> | |||||
| <h2><code>TRELLO_APP_KEY</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>TWILIO_ACCOUNT</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>TWILIO_AUTH</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>TWILIO_FROM</code></h2> | |||||
| <p>Default: <code>None</code></p> | |||||
| <h2><code>TWILIO_USE_WHATSAPP</code></h2> | |||||
| <p>Default: <code>False</code></p> | |||||
| <h2><code>USE_PAYMENTS</code></h2> | |||||
| <p>Default: <code>False</code></p> | |||||
| <p>A boolean that turns on/off billing features.</p> | |||||
+ 476
- 0
templates/docs/self_hosted_configuration.md
View File
| @ -0,0 +1,476 @@ | |||||
| # Server Configuration | |||||
| Healthchecks prepares its configuration in `hc/settings.py`. It reads configuration | |||||
| from environment variables. Below is a list of variables it reads and uses: | |||||
| ## `ALLOWED_HOSTS` | |||||
| Default: `*` | |||||
| A list of strings representing the host/domain names that this site can serve. | |||||
| You can specify multiple domain names by separating them with commas: | |||||
| ```ini | |||||
| ALLOWED_HOSTS=my-hc.example.org,alternative-name.example.org | |||||
| ``` | |||||
| Aside from the comma-separated syntax, this is a standard Django setting. | |||||
| Read more about it in the | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#allowed-hosts). | |||||
| ## `APPRISE_ENABLED` | |||||
| Default: `False` | |||||
| A boolean that turns on/off the [Apprise](https://github.com/caronc/apprise) | |||||
| integration. | |||||
| Before enabling the Apprise integration, make sure the `apprise` package is installed: | |||||
| ```bash | |||||
| pip install apprise | |||||
| ``` | |||||
| ## `DEBUG` | |||||
| Default: `True` | |||||
| A boolean that turns on/off debug mode. | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#debug). | |||||
| ## `DEFAULT_FROM_EMAIL` | |||||
| Default: `[email protected]` | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#default-from-email). | |||||
| ## `DB` | |||||
| Default: `sqlite` | |||||
| The database enginge to use. Possible values: `sqlite`, `postgres`, `mysql`. | |||||
| ## `DB_CONN_MAX_AGE` | |||||
| Default: `0` | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#conn-max-age). | |||||
| ## `DB_HOST` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#host). | |||||
| ## `DB_NAME` | |||||
| Default: `hc` (PostgreSQL, MySQL) or `{project-path}/hc.sqlite` (SQLite) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#name). | |||||
| ## `DB_PASSWORD` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#password). | |||||
| ## `DB_PORT` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#port). | |||||
| ## `DB_SSLMODE` | |||||
| Default: `prefer` | |||||
| PostgreSQL-specific, [details](https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) | |||||
| ## `DB_TARGET_SESSION_ATTRS` | |||||
| Default: `read-write` | |||||
| PostgreSQL-specific, [details](https://www.postgresql.org/docs/10/libpq-connect.html#LIBPQ-CONNECT-TARGET-SESSION-ATTRS) | |||||
| ## `DB_USER` | |||||
| Default: `postgres` (PostgreSQL) or `root` (MySQL) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#user). | |||||
| ## `DISCORD_CLIENT_ID` | |||||
| Default: `None` | |||||
| The Discord Client ID, required by the Discord integration. | |||||
| To set up the Discord integration: | |||||
| * Register a new application at | |||||
| [https://discordapp.com/developers/applications/me](https://discordapp.com/developers/applications/me) | |||||
| * Add a Redirect URI to your Discord application. The URI format is | |||||
| `SITE_ROOT/integrations/add_discord/`. For example, if `your SITE_ROOT` | |||||
| is `https://my-hc.example.org` then the Redirect URI would be | |||||
| `https://my-hc.example.org/integrations/add_discord/` | |||||
| * Look up your Discord app's _Client ID_ and _Client Secret_. Put them | |||||
| in the `DISCORD_CLIENT_ID` and `DISCORD_CLIENT_SECRET` environment | |||||
| variables. | |||||
| ## `DISCORD_CLIENT_SECRET` | |||||
| Default: `None` | |||||
| The Discord Client Secret, required by the Slack integration. Look it up at | |||||
| [https://discordapp.com/developers/applications/me](https://discordapp.com/developers/applications/me). | |||||
| ## `EMAIL_HOST` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#email-host). | |||||
| ## `EMAIL_HOST_PASSWORD` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-password). | |||||
| ## `EMAIL_HOST_USER` | |||||
| Default: `""` (empty string) | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#email-host-user). | |||||
| ## `EMAIL_PORT` | |||||
| Default: `587` | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#email-port). | |||||
| ## `EMAIL_USE_TLS` | |||||
| Default: `True` | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#email-use-tls). | |||||
| ## `EMAIL_USE_VERIFICATION` | |||||
| Default: `True` | |||||
| A boolean that turns on/off a verification step when adding an email integration. | |||||
| If enabled, whenever an user adds an email integration, Healthchecks emails a | |||||
| verification link to the new address. The new integration becomes active only | |||||
| after user clicks the verification link. | |||||
| If you are setting up a private healthchecks instance where | |||||
| you trust your users, you can opt to disable the verification step. In that case, | |||||
| set `EMAIL_USE_VERIFICATION` to `False`. | |||||
| ## `LINENOTIFY_CLIENT_ID` | |||||
| Default: `None` | |||||
| ## `LINENOTIFY_CLIENT_SECRET` | |||||
| Default: `None` | |||||
| ## `MASTER_BADGE_LABEL` | |||||
| Default: same as `SITE_NAME` | |||||
| ## `MATRIX_ACCESS_TOKEN` | |||||
| Default: `None` | |||||
| The [Matrix](https://matrix.org/) bot user's access token, required by the Matrix | |||||
| integration. | |||||
| To set up the Matrix integration: | |||||
| * Register a bot user (for posting notifications) in your preferred Matrix homeserver. | |||||
| * Use the [Login API call](https://www.matrix.org/docs/guides/client-server-api#login) | |||||
| to retrieve bot user's access token. You can run it as shown in the documentation, | |||||
| using curl in command shell. | |||||
| * Set the `MATRIX_` environment variables. Example: | |||||
| ```ini | |||||
| MATRIX_ACCESS_TOKEN=[a long string of characters returned by the login call] | |||||
| MATRIX_HOMESERVER=https://matrix.org | |||||
| MATRIX_USER_ID=@mychecks:matrix.org | |||||
| ``` | |||||
| ## `MATRIX_HOMESERVER` | |||||
| Default: `None` | |||||
| The Matrix bot's homeserver address, required by the Matrix integration. | |||||
| ## `MATRIX_USER_ID` | |||||
| Default: `None` | |||||
| The Matrix bot's user identifier, required by the Matrix integration. | |||||
| ## `PD_VENDOR_KEY` | |||||
| Default: `None` | |||||
| [PagerDuty](https://www.pagerduty.com/) vendor key, | |||||
| required by the PagerDuty integration. | |||||
| ## `PING_BODY_LIMIT` | |||||
| Default: `10000` | |||||
| The upper size limit in bytes for logged ping request bodies. | |||||
| The default value is 10000 (10 kilobytes). You can adjust the limit or you can remove | |||||
| the it altogether by setting this value to `None`. | |||||
| ## `PING_EMAIL_DOMAIN` | |||||
| Default: `localhost` | |||||
| ## `PING_ENDPOINT` | |||||
| Default: `http://localhost:8000/ping/` | |||||
| ## `PUSHBULLET_CLIENT_ID` | |||||
| Default: `None` | |||||
| ## `PUSHBULLET_CLIENT_SECRET` | |||||
| Default: `None` | |||||
| ## `PUSHOVER_API_TOKEN` | |||||
| Default: `None` | |||||
| The [Pushover](https://pushover.net/) API token, required by the Pushover integration. | |||||
| To enable the Pushover integration: | |||||
| * Register a new Pushover application at | |||||
| [https://pushover.net/apps/build](https://pushover.net/apps/build). | |||||
| * Within the Pushover application configuration, enable subscriptions. | |||||
| Make sure the subscription type is set to "URL". Also make sure the redirect | |||||
| URL is configured to point back to the root of the Healthchecks instance | |||||
| (e.g., `https://my-hc.example.org/`). | |||||
| * Put the Pushover application's _API Token_ and the _Subscription URL_ in | |||||
| `PUSHOVER_API_TOKEN` and `PUSHOVER_SUBSCRIPTION_URL` environment | |||||
| variables. The Pushover subscription URL should look similar to | |||||
| `https://pushover.net/subscribe/yourAppName-randomAlphaNumericData`. | |||||
| ## `PUSHOVER_EMERGENCY_EXPIRATION` | |||||
| Default: `86400` (24 hours) | |||||
| Specifies how many seconds an emergency Pushoover notification | |||||
| will continue to be retried for. | |||||
| More information in [Pushover API documentation](https://pushover.net/api#priority). | |||||
| ## `PUSHOVER_EMERGENCY_RETRY_DELAY` | |||||
| Default: `300` (5 minutes) | |||||
| Specifies how often (in seconds) the Pushover servers will send the same notification | |||||
| to the user. | |||||
| More information in [Pushover API documentation](https://pushover.net/api#priority). | |||||
| ## `PUSHOVER_SUBSCRIPTION_URL` | |||||
| Default: `None` | |||||
| The Pushover Subscription URL, required by the Pushover integration. | |||||
| ## `REGISTRATION_OPEN` | |||||
| Default: `True` | |||||
| A boolean that controls whether site visitors can create new accounts. | |||||
| Set it to `False` if you are setting up a private Healthchecks instance, but | |||||
| it needs to be publicly accessible (so, for example, your cloud services | |||||
| can send pings to it). | |||||
| If you close new user registration, you can still selectively invite users | |||||
| to your team account. | |||||
| ## `REMOTE_USER_HEADER` | |||||
| Default: `None` | |||||
| Specifies the request header to use for external authentication. | |||||
| Healthchecks supports external authentication by means of HTTP headers set by | |||||
| reverse proxies or the WSGI server. This allows you to integrate it into your | |||||
| existing authentication system (e.g., LDAP or OAuth) via an authenticating proxy. When this option is enabled, **Healtchecks will trust the header's value implicitly**, so it is **very important** 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. | |||||
| To enable this feature, set the `REMOTE_USER_HEADER` value to a header you wish to authenticate with. HTTP headers will be prefixed with `HTTP_` and have any dashes converted to underscores. Headers without that prefix can be set by the WSGI server itself only, which is more secure. | |||||
| When `REMOTE_USER_HEADER` is set, Healthchecks will: | |||||
| - assume the header contains user's email address | |||||
| - look up and automatically log in the user with a matching email address | |||||
| - automatically create an user account if it does not exist | |||||
| - disable the default authentication methods (login link to email, password) | |||||
| ## `RP_ID` | |||||
| Default: `None` | |||||
| The [Relying Party identifier](https://www.w3.org/TR/webauthn-2/#relying-party-identifier), | |||||
| required by the WebAuthn second-factor authentication feature. | |||||
| Healthchecks optionally supports two-factor authentication using the WebAuthn | |||||
| standard. To enable WebAuthn support, set the `RP_ID` setting to a non-null value. | |||||
| Set its value to your site's domain without scheme and without port. For example, | |||||
| if your site runs on `https://my-hc.example.org`, set `RP_ID` to `my-hc.example.org`. | |||||
| Note that WebAuthn requires HTTPS, even if running on localhost. To test WebAuthn | |||||
| locally with a self-signed certificate, you can use the `runsslserver` command | |||||
| from the `django-sslserver` package. | |||||
| ## `SECRET_KEY` | |||||
| Default: `""` (empty string) | |||||
| A secret key used for cryptographic signing. | |||||
| This is a standard Django setting, read more in | |||||
| [Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#secret-key). | |||||
| ## `SHELL_ENABLED` | |||||
| Default: `False` | |||||
| A boolean that turns on/off the "Shell Commands" integration. | |||||
| The "Shell Commands" integration runs user-defined local shell commands when checks | |||||
| go up or down. This integration is disabled by default, and can be enabled by setting | |||||
| the `SHELL_ENABLED` environment variable to `True`. | |||||
| Note: be careful when using "Shell Commands" integration, and only enable it when | |||||
| you fully trust the users of your Healthchecks instance. The commands will be executed | |||||
| by the `manage.py sendalerts` process, and will run with its system permissions. | |||||
| ## `SIGNAL_CLI_ENABLED` | |||||
| Default: `False` | |||||
| A boolean that turns on/off the [Signal](https://signal.org/) integration. | |||||
| Healthchecks uses [signal-cli](https://github.com/AsamK/signal-cli) to send Signal | |||||
| notifications. Healthcecks interacts with signal-cli over DBus. | |||||
| To enable the Signal integration: | |||||
| * Set up and configure signal-cli to listen on DBus system bus | |||||
| ([instructions](https://github.com/AsamK/signal-cli/wiki/DBus-service)). | |||||
| Make sure you can send test messages from command line, using the `dbus-send` | |||||
| example given in the signal-cli instructions. | |||||
| * Set the `SIGNAL_CLI_ENABLED` environment variable to `True`. | |||||
| ## `SITE_ROOT` | |||||
| Default: `http://localhost:8000` | |||||
| ## `SITE_NAME` | |||||
| Default: `Mychecks` | |||||
| ## `SLACK_CLIENT_ID` | |||||
| Default: `None` | |||||
| The Slack Client ID, required by the Slack integration. | |||||
| Go to [https://api.slack.com/apps/](https://api.slack.com/apps/) | |||||
| to create a _Slack app_, and look up its _Client ID_ and _Client Secret_. | |||||
| When setting up the Slack app, make sure to: | |||||
| * Add the [incoming-webhook](https://api.slack.com/scopes/incoming-webhook) | |||||
| scope to the Bot Token Scopes. | |||||
| * Add a _Redirect URL_ in the format `SITE_ROOT/integrations/add_slack_btn/`. | |||||
| For example, if your `SITE_ROOT` is `https://my-hc.example.org` then the | |||||
| Redirect URL would be `https://my-hc.example.org/integrations/add_slack_btn/`. | |||||
| ## `SLACK_CLIENT_SECRET` | |||||
| Default: `None` | |||||
| The Slack Client Secret, required by the Slack integration. | |||||
| Look it up at [https://api.slack.com/apps/](https://api.slack.com/apps/). | |||||
| ## `TELEGRAM_BOT_NAME` | |||||
| Default: `ExampleBot` | |||||
| The [Telegram](https://telegram.org/) bot name, required by the Telegram integration. | |||||
| To set up the Telegram integration: | |||||
| * Create a Telegram bot by talking to the | |||||
| [BotFather](https://core.telegram.org/bots#6-botfather). Set the bot's name, | |||||
| description, user picture, and add a "/start" command. | |||||
| * After creating the bot you will have the bot's name and token. Put them | |||||
| in `TELEGRAM_BOT_NAME` and `TELEGRAM_TOKEN` environment variables. | |||||
| * Run the `settelegramwebhook` management command. This command tells Telegram | |||||
| where to forward channel messages by invoking Telegram's | |||||
| [setWebhook](https://core.telegram.org/bots/api#setwebhook) API call: | |||||
| ```bash | |||||
| $ ./manage.py settelegramwebhook | |||||
| Done, Telegram's webhook set to: https://my-monitoring-project.com/integrations/telegram/bot/ | |||||
| ``` | |||||
| For this to work, your `SITE_ROOT` must be publicy accessible and use the "https://" | |||||
| scheme. | |||||
| ## `TELEGRAM_TOKEN` | |||||
| Default: `None` | |||||
| The Telegram bot user's authentication token, required by the Telegram integration. | |||||
| ## `TRELLO_APP_KEY` | |||||
| Default: `None` | |||||
| ## `TWILIO_ACCOUNT` | |||||
| Default: `None` | |||||
| ## `TWILIO_AUTH` | |||||
| Default: `None` | |||||
| ## `TWILIO_FROM` | |||||
| Default: `None` | |||||
| ## `TWILIO_USE_WHATSAPP` | |||||
| Default: `False` | |||||
| ## `USE_PAYMENTS` | |||||
| Default: `False` | |||||
| A boolean that turns on/off billing features. | |||||