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

Update documentation to say tasks are signed, not encrypted #429

Merged
merged 1 commit into from
Apr 21, 2020
Merged

Update documentation to say tasks are signed, not encrypted #429

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
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Features
- Multiprocessing worker pool
- Asynchronous tasks
- Scheduled and repeated tasks
- Encrypted and compressed packages
- Signed and compressed packages
- Failure and success database or cache
- Result hooks, groups and chains
- Django Admin integration
Expand Down
4 changes: 2 additions & 2 deletions docs/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ On most broker types this will be used as the queue name.
Defaults to ``'default'``.

.. note::
Tasks are encrypted. When a worker encounters a task it can not decrypt, it will be discarded or failed.
Tasks are signed. When a worker encounters a task with an invalid signature, it will be discarded or failed.

workers
~~~~~~~
Expand Down Expand Up @@ -207,7 +207,7 @@ of the cache connection you want to use instead of a direct Redis connection::


.. tip::
Django Q uses your ``SECRET_KEY`` to encrypt task packages and prevent task crossover. So make sure you have it set up in your Django settings.
Django Q uses your ``SECRET_KEY`` to sign task packages and prevent task crossover. So make sure you have it set up in your Django settings.

.. _disque_configuration:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Features
- Multiprocessing worker pools
- Asynchronous tasks
- Scheduled and repeated tasks
- Encrypted and compressed packages
- Signed and compressed packages
- Failure and success database or cache
- Result hooks, groups and chains
- Django Admin integration
Expand Down