Comment on page
We will use Docker to run all the services needed, except for Node.js which we will run locally.
First you will need to clone the Git repository:
git clone https://github.com/getredash/redash.git
.envfile at the root and set any environment variables you need.
$ touch .env
Once you have the above setup, you need to create the Docker services:
docker-compose up -d
This will build the Docker images and fetch some prebuilt images and then start the services (Redash web server, worker, PostgreSQL and Redis). You can refer to the
docker-compose.ymlfile to see the full configuration.
If you hit an
errno 134particularly at
RUN yarn build, make sure you give your Docker VM enough memory (4GB or more).
# Create tables
docker-compose run --rm server create_db
# Create database for tests
docker-compose run --rm postgres psql -h postgres -U postgres -c "create database tests"
After your installation is complete, you can do the healthcheck by calling
Once all Docker services are running (can be started either by
docker-compose start), Redash is available at
While we will use webpack’s dev server, we still need to build the frontend assets at least once, as some of them used for static pages (login page and such):
To work on the frontend code, you need to use the webpack dev server, which you start with:
Now the dev server is available at
http://localhost:8080. It rebuilds the frontend code when you change it and refreshes the browser. All the API calls are proxied to
localhost:5000(the server running in Docker).
If you pulled a new version with new packages or added some yourself, you will need to rebuild the
docker-compose build worker
docker-compose build server
docker-compose run --rm server tests
Before running tests for the first time, you need to create a database for tests:
docker-compose run --rm postgres psql -h postgres -U postgres -c "create database tests;"