Really basic question from a noob re: getting set up locally with Docker

[mitya33]

Hi all,

I should say off the bat that I find Redash quite intimidating as I'm no sys-admin. My aim is to get it running locally with Docker.

To that end, I've done the following:

• Created docker-compose.yml and given it the exact same contents as the suggested compose file in the Redash GH repo
• Started Docker Desktop
• Run docker compose up

This gives me an error about failing to read dockerfile. Now, I know, I know, it must be blindingly obvious to someone reading this what I'm doing wrong, but Redash is presumably intended for sys-admins and assumes the reader has all sorts of knowledge, and so didn't explicitly say I needed to create a dockerfile first, or what to put in it.

To this end, I'd be hugely grateful if someone could just point me in the right direction as to what I need to do!

Thank you in advance.

[arikfr]

The file in the repo is a template, and the image name is being replaced dynamically by the setup script. If you're running it manually, you’ll need to set it explicitly. The latest stable version should be image: redash/redash:v25.1.0.

Also, note that it tries to load an .env file from this path: /opt/redash/env (see line 6). You can change that to wherever your environment file is located.

Lastly, on line 44, it sets the Postgres data volume path — you might want to update that too, depending on your setup.

Once you've made those 3 adjustments, running docker compose up should work.

[kfearnley-bidpath-com]

Hi, I'm also trying to set up a demo instance of redash on a Windows dev machine under docker.
I tried to follow the instructions at https://redash.io/help/open-source/setup/
I am new to Docker and (obviously) to redash but got a few other reporting things running in Docker with few problems (e.g. Metabase).
The link in the setup instructions to the "docker image" links to a page with a "Run in Docker Desktop" button rather than an image directly.
That button seemed to work in that it created the docker container, etc. but it does not run... I get an exception "You must set the REDASH_COOKIE_SECRET environment variable".

The setup page does say that a secret key and a cookie secret key are needed "if you do not use one of our cloud images", so I thought I might not need to do that.
However I can't see how to set those environment variables within the docker container/image that was created.

I tried copying the run command in Docker, then using the Docker terminal to add the "env=..." parameters to the run command and this gave a different error "redis.exeptions.ConnectionError: Error 111 connecting to localhost:6379. Connection refused".

I hope it's a quick thing that's just down to my ignorance of Docker - any help would be greatly appreciated - thanks!

[arikfr]

Do you want to just run a Redash instance locally or do you need a dev setup?

[kfearnley-bidpath-com]

Thanks for the response... I'm trying to investigate it for possible use on a project so I think I just need a local demo/vanilla instance of some kind that I can play with... to start with at least. If it looks promising for what we need, then we'd need dev setups at that stage.

[arikfr]

I created a simple Docker Compose setup you can run locally. I tried it only on MacOS, but I believe it should work on Windows as well. Save the following as a compose.yaml file:

x-redash-service: &redash-service
  image: redash/redash:25.8.0
  depends_on:
    - postgres
    - redis
  restart: always
x-redash-environment: &redash-environment
  REDASH_HOST: http://localhost:5001
  REDASH_LOG_LEVEL: "INFO"
  PYTHONUNBUFFERED: "0"
  REDASH_REDIS_URL: "redis://redis:6379/0"
  REDASH_DATABASE_URL: "postgresql://postgres@postgres/postgres"
  REDASH_ENFORCE_CSRF: "true"
  REDASH_GUNICORN_TIMEOUT: "60"
  # Replace the following with actual secrets
  REDASH_COOKIE_SECRET: SOMETHING_SECRET
  REDASH_SECRET_KEY: ANOTHER_SECRET
services:
  database_setup:
    <<: *redash-service
    command: create_db
    depends_on:
      - postgres
      - redis
    environment:
      <<: *redash-environment
    restart: "no"
  server:
    <<: *redash-service
    command: server
    depends_on:
      - database_setup
    ports:
      - "5001:5000"
    environment:
      <<: *redash-environment
      REDASH_WEB_WORKERS: 2
  scheduler:
    <<: *redash-service
    command: scheduler
    depends_on:
      - server
    environment:
      <<: *redash-environment
  scheduled_worker:
    <<: *redash-service
    command: worker
    depends_on:
      - server
    environment:
      <<: *redash-environment
      QUEUES: "scheduled_queries,schemas,periodic,emails,default"
      WORKERS_COUNT: 1
  adhoc_worker:
    <<: *redash-service
    command: worker
    depends_on:
      - server
    environment:
      <<: *redash-environment
      QUEUES: "queries"
      WORKERS_COUNT: 1
  redis:
    image: redis:7-alpine
    restart: unless-stopped
  postgres:
    image: pgautoupgrade/pgautoupgrade:latest
    # Uncomment and set a path if you want the volume to actually persist to 
    # a known location on disk.
    #volumes:
    #  - /opt/redash/postgres-data:/var/lib/postgresql/data
    restart: unless-stopped
    environment:
      POSTGRES_HOST_AUTH_METHOD: "trust"

And then run: docker-compose up or docker-compose up -d if you want it to run in the background.

Give it a moment to start everything and run migration after which, it should be available on http://localhost:5001.

Some notes:

1. You might want to update the secrets on lines 16-17.
2. If you the Postgres database to persist data in a known location (in case you want to back it up or move elsewhere) you will need to uncomment lines 70-71 and set a proper path.

This is a minimal setup which is not recommended for production.

Let me know how it goes.

[kfearnley-bidpath-com]

Thank you so much!
That worked... although I got no response on localhost:5001 I used localhost:5001/setup and was able to get started and connect my data source... I'm up and running.
Thanks again - really appreciate your help and time on this.