Skip to content

Commit

Permalink
celery docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nitely committed Sep 13, 2020
1 parent 1c0286d commit b41aee4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/index.rst
Expand Up @@ -14,8 +14,8 @@ User’s Guide

installation
upgrade
settings
task_manager
settings

Additional Notes
----------------
Expand Down
14 changes: 12 additions & 2 deletions docs/task_manager.rst
Expand Up @@ -10,7 +10,7 @@ The supported task managers to run these tasks are

While Spirit can run without a task manager, some of the
tasks may not run, as they are too expensive to run as part
of the request cycle (web server), or they are require to be run
of the request-response cycle (web server), or they are require to be run
periodically.

Functionality that does not work without a task manager includes:
Expand Down Expand Up @@ -38,7 +38,7 @@ Set Huey as the Spirit task manager::
The ``settings/prod.py`` and ``settings/dev.py`` files include sample
configuration for Huey. The ``prod.py`` settings set Redis as the backend,
and the ``dev.py`` settings set SQLite as the backend. Redis is recommended
for production environments, and it's a good option to use as Django cache
for production environments, and it's a good option to use as the Django cache
as well.

How to install `Redis <https://redis.io/>`_ depends on the OS, for example
Expand Down Expand Up @@ -114,3 +114,13 @@ To start the periodic task manager, run::
celery -A mysite beat -l info

Note this will just enqueue tasks that will later be consumed by the worker.

Celery does not work
********************

Celery likes to break all the things in every major version.
The celery configuration (including ``prod.py``, ``dev.py``, and
``mysite/celery.py``) were tested on ``v4.4.7``.

I'm not a Celery user. These docs and the Celery support are a
community effort. Please, send a PR if something breaks.

0 comments on commit b41aee4

Please sign in to comment.