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

add doc on celery related setup #298

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

add doc on celery related setup #298

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
5 changes: 5 additions & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ Advantages of this option
1. Set up Celery
2. Set `REPORT_BUILDER_ASYNC_REPORT = True` in settings.py

### Celery Setup
Django report builder's "scheduled report" and "asynchronous report" depends on Celery. Celery's official documentation is very good at explaining the setting: http://docs.celeryproject.org/en/latest/django/first-steps-with-django.html#using-celery-with-django.

If we do not need these two features, then no need to install Celery.

### Email notification when file is uploaded

The reports are emailed to the current user rather than generated and then downloaded. This is if you have reports that take a while to generate or if you'd prefer your users to be emailed.
Expand Down