Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move the description of HEALTHCHECK_CACHE_KEY to the correct section #416

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Move the description of HEALTHCHECK_CACHE_KEY to the correct section #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/contrib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,3 @@ all the time.

You may also use both of them. To use these checks add them to `INSTALLED_APPS` in your
Django settings module.

`cache`
-------

The key `djangohealtcheck_test` will be written to the cache backend to validate that the cache is working.
The name of the key can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value.
22 changes: 18 additions & 4 deletions docs/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ You can still use any uptime bot that is URL based while enjoying token protecti
Do NOT use Django's `SECRET_KEY` setting. This should never be exposed,
to any third party. Not even your trusted uptime bot.

`cache`
-------

The cache backend uses the following setting:

.. list-table::
:widths: 25 10 10 55
:header-rows: 1

* - Name
- Type
- Default
- Description
* - `HEALTHCHECK_CACHE_KEY`
- String
- `djangohealthcheck_test`
- Specifies the name of the key to write to and read from to validate that the cache is working.

`psutil`
--------

Expand Down Expand Up @@ -83,10 +101,6 @@ Using `django.settings` you may exert more fine-grained control over the behavio
- Type
- Default
- Description
* - `HEALTHCHECK_CACHE_KEY`
- String
- `djangohealtcheck_test`
- Specifies the name of the key to write to and read from to validate that the cache is working.
* - `HEALTHCHECK_CELERY_QUEUE_TIMEOUT`
- Number
- `3`
Expand Down
Loading