Developer Installation Guide
PostgreSQL & Redis
Refer to the documentation of Python (3), PostgreSQL (9.6 or newer), Redis (3 or newer), Node.js (14.16.1 or newer) on how to install them in your environment. On MacOS, you can use Homebrew to install them. On Linux you can use your package manager, although you need to make sure it installs recent enough versions.
For development the minimum required packages to install are described in:
You install them with pip:
pip install -r requirements.txt -r requirements_dev.txt
(We recommend installing them in a
virtual environment. For
certain data source types you need to install additional dependencies from
Install Yarn (1.22.10 or newer):
npm install --global email@example.com
Install all packages with:
First time build assets:
Versions of Redash prior to V10 used
npm instead of
In most cases the default configuration is enough for development. But if you need to adjust the database configuration, mail, or other settings you do so with environment variables.
Creating Database Tables
./manage.py database create_tables
The main Redash processes you have to run:
- Web server
- RQ worker(s) & scheduler
In development you will also run Webpack’s dev server or watch utility.
- Web server:
./manage.py runserver --debugger --reload
./manage.py rq worker
- RQ Scheduler:
./manage.py rq scheduler
- Frontend watch process to rebuild changes:
This will result in a Flask web server listening on port
rebuilding changes to the frontend, RQ worker ready to run queries and RQ
scheduler to enqueue periodic tasks.
Health Check for Installation
Frontend tests using Cypress: