From 400c7367065ff4fed12f4928944036acf9d825c7 Mon Sep 17 00:00:00 2001 From: Yuki9814 Date: Mon, 16 Mar 2026 01:25:26 +0800 Subject: [PATCH] docs: note Redis requirement in Celery example README --- examples/celery/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/examples/celery/README.md b/examples/celery/README.md index 038eb51e..02a9a31d 100644 --- a/examples/celery/README.md +++ b/examples/celery/README.md @@ -8,6 +8,18 @@ submitting tasks and polling results, and how to use that API with JavaScript. S From this directory, create a virtualenv and install the application into it. Then run a Celery worker. +This example configures Celery to use Redis as the broker and result backend, so make +sure Redis is installed and running locally before starting the worker. Install Redis +using your system package manager, then verify that it is available on ``localhost``. + +```shell +# On Debian / Ubuntu: +$ sudo apt install redis-server +$ sudo service redis start +$ redis-cli ping +PONG +``` + ```shell $ python3 -m venv .venv $ . ./.venv/bin/activate