Documentation not correct, almost impossible to setup for testing

[mudasirmirza]

Hi,

I was trying to setup redash for testing purposes, to check how can I use this in my environment. I was following documentation Docker Based Developer Installation Guide which is at this link https://redash.io/help/open-source/dev-guide/docker

The 2nd point in the which tells the nodejs requirement and its version, where is clearly mentions Install Node.js (14.16.1 or newer, can be installed with Homebrew on OS/X), so ideally new version should work. I am getting below error with node version 17.3.1.

I am getting this error when I run yarn --frozen-lockfile

error redash-client@11.0.0-dev: The engine “node” is incompatible with this module. Expected version “^14.16.1”. Got “17.3.1”

To overcome this, I modified the package.json file and changed the engines.version.

Now I moved to the step where we need to create docker services. Now I ran docker-compose up -d and immediately I get error saying we are missing .env file. No where in this page it is mentioned about the .env file and what has to be in this file. After almost an hour of trying to figure out what are the minimum environment variables required, I got it REDASH_COOKIE_SECRET and REDASH_SECRET_KEY.
Please update the documentation.

Another error I faced was something related to tsc missing, to resolve this I have to run npm install typescript -g. Not mentioned anywhere in the documentation.

The create database part I think is the only step which did not give any error.
Just to be on the safe side, I created the database for tests.

Just as clarification, please mention full command to run ping. The command is simply curl http://localhost:5000/ping

Rest of the steps worked fine.

After these changes and testing out a few things here and there. I was finally able to run redash and test it.

It will be great it we can have the documentation updated

Regards,
Mudasir Mirza.

[justinclift]

Hi Mudasir,

Out of curiosity, when you say you’re doing this “for testing purposes”, are you meaning “I just want to try out Redash”, or are you meaning “I want to build Redash from source code, for testing that”?

Asking because if you just want to test out Redash itself, it’s a different (much easier) guide to follow:

Setting up a Redash Instance

Hopefully that helps.

[mudasirmirza]

Hi Justin,

Initially I just wanted to “try out Redash” but ended up setting up proper development environment and almost finishing up writing query runner for NewRelic and most probably in a week for OpsGenie also.

Regards,
Mudasir Mirza

[adamzwakk]

Just wanted to say thanks for this @mudasirmirza, was trying to get my docker env up and found that the docs were outdated for the same reasons you stated.

[jesse]

@mudasirmirza

Now I moved to the step where we need to create docker services. Now I ran docker-compose up -d and immediately I get error saying we are missing .env file . No where in this page it is mentioned about the .env file and what has to be in this file. After almost an hour of trying to figure out what are the minimum environment variables required, I got it REDASH_COOKIE_SECRET and REDASH_SECRET_KEY .
Please update the documentation.

Good catch! Sorry for your frustration here. I opened a pull request with this documentation change back in December and failed to merge it. Those details are now included:

@adamzwakk

Just wanted to say thanks for this @mudasirmirza, was trying to get my docker env up and found that the docs were outdated for the same reasons you stated.

Will give these instructions a full once-over to make sure they’re accurate. I run through this devloop pretty frequently and haven’t had these issues. So it would be helpful to know if you ran into specific hurdles apart from the .env file requirements (which are now documented).