diff --git a/templates/docs/self_hosted_configuration.html b/templates/docs/self_hosted_configuration.html index 81bcaf71..8c72d3e4 100644 --- a/templates/docs/self_hosted_configuration.html +++ b/templates/docs/self_hosted_configuration.html @@ -19,16 +19,6 @@ integration.

pip install apprise
 
-

DEBUG

-

Default: True

-

A boolean that turns on/off debug mode.

-

Never run a Healthchecks instance in production with the debug mode turned on!

-

This is a standard Django setting, read more in -Django documentation.

-

DEFAULT_FROM_EMAIL

-

Default: healthchecks@example.org

-

This is a standard Django setting, read more in -Django documentation.

DB

Default: sqlite

The database enginge to use. Possible values: sqlite, postgres, mysql.

@@ -62,6 +52,16 @@ integration.

Default: postgres (PostgreSQL) or root (MySQL)

This is a standard Django setting, read more in Django documentation.

+

DEBUG

+

Default: True

+

A boolean that turns on/off debug mode.

+

Never run a Healthchecks instance in production with the debug mode turned on!

+

This is a standard Django setting, read more in +Django documentation.

+

DEFAULT_FROM_EMAIL

+

Default: healthchecks@example.org

+

This is a standard Django setting, read more in +Django documentation.

DISCORD_CLIENT_ID

Default: None

The Discord Client ID, required by the Discord integration.

@@ -256,14 +256,14 @@ notifications. Healthcecks interacts with signal-cli over DBus.

example given in the signal-cli instructions.
  • Set the SIGNAL_CLI_ENABLED environment variable to True.
  • -

    SITE_ROOT

    -

    Default: http://localhost:8000

    -

    The base URL of this Healthchecks instance. Healthchecks uses SITE_ROOT whenever -it needs to construct absolute URLs.

    SITE_NAME

    Default: Mychecks

    The display name of this Healthchecks instance. Healthchecks uses it throughout its web UI and documentation.

    +

    SITE_ROOT

    +

    Default: http://localhost:8000

    +

    The base URL of this Healthchecks instance. Healthchecks uses SITE_ROOT whenever +it needs to construct absolute URLs.

    SLACK_CLIENT_ID

    Default: None

    The Slack Client ID, required by the Slack integration.

    diff --git a/templates/docs/self_hosted_configuration.md b/templates/docs/self_hosted_configuration.md index 9ef2e15b..9f58089c 100644 --- a/templates/docs/self_hosted_configuration.md +++ b/templates/docs/self_hosted_configuration.md @@ -31,24 +31,6 @@ Before enabling the Apprise integration, make sure the `apprise` package is inst pip install apprise ``` -## `DEBUG` {: #DEBUG } - -Default: `True` - -A boolean that turns on/off debug mode. - -_Never run a Healthchecks instance in production with the debug mode turned on!_ - -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_FROM_EMAIL } - -Default: `healthchecks@example.org` - -This is a standard Django setting, read more in -[Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#default-from-email). - ## `DB` {: #DB } Default: `sqlite` @@ -109,6 +91,24 @@ 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). +## `DEBUG` {: #DEBUG } + +Default: `True` + +A boolean that turns on/off debug mode. + +_Never run a Healthchecks instance in production with the debug mode turned on!_ + +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_FROM_EMAIL } + +Default: `healthchecks@example.org` + +This is a standard Django setting, read more in +[Django documentation](https://docs.djangoproject.com/en/3.1/ref/settings/#default-from-email). + ## `DISCORD_CLIENT_ID` {: #DISCORD_CLIENT_ID } Default: `None` @@ -408,13 +408,6 @@ To enable the Signal integration: example given in the signal-cli instructions. * Set the `SIGNAL_CLI_ENABLED` environment variable to `True`. -## `SITE_ROOT` {: #SITE_ROOT } - -Default: `http://localhost:8000` - -The base URL of this Healthchecks instance. Healthchecks uses `SITE_ROOT` whenever -it needs to construct absolute URLs. - ## `SITE_NAME` {: #SITE_NAME } Default: `Mychecks` @@ -422,6 +415,13 @@ Default: `Mychecks` The display name of this Healthchecks instance. Healthchecks uses it throughout its web UI and documentation. +## `SITE_ROOT` {: #SITE_ROOT } + +Default: `http://localhost:8000` + +The base URL of this Healthchecks instance. Healthchecks uses `SITE_ROOT` whenever +it needs to construct absolute URLs. + ## `SLACK_CLIENT_ID` {: #SLACK_CLIENT_ID } Default: `None`