Doc improvement for docker-compose #1380
Conversation
There was a problem hiding this comment.
Thanks! Docs improvements are always appreciated.
Please see my comments & please apply them to https://github.com/getredash/website/blob/master/onpremise/setup/setting-up-redash-instance.md as the docs moved there... (you submitted the pull request right before me deleting the docs folder).
| (``$REDASH_DIR`` refers to the top-level directory of your Redash git repository clone.) | ||
|
|
||
| #. Install docker and docker-compose. | ||
| #. ``cd $REDASH_DIR``. |
There was a problem hiding this comment.
Why not keep the original instruction (#2 above)? I find it much more understandable than this. You don't use $REDASH_DIR anywhere else anyway.
|
|
||
| First ssh to your instance and change directory to ``/opt/redash``. If | ||
| you're using the GCE image, switch to root (``sudo su``). | ||
| First connect to your instance using ssh, and switch to root (``sudo su``). |
| #. ``cd $REDASH_DIR``. | ||
| #. ``cp docker-compose-example.yml docker-compose.yml`` | ||
| #. ``docker-compose up postgres``. | ||
| #. Change to another terminal. |
| you're using the GCE image, switch to root (``sudo su``). | ||
| First connect to your instance using ssh, and switch to root (``sudo su``). | ||
|
|
||
| If you're using the Docker image, ``docker exec -i -t redash_redash_1 /bin/bash``, will put you in ``/opt/redash/current`` as root. |
There was a problem hiding this comment.
- They should use Compose's exec. This way no need to assume that the name will be
redash_redash_1. - I'm not sure this is needed. Is there a change they can'tdo via the env variables?
| Most of the settings you need to edit are in the ``/opt/redash/.env`` | ||
| file. | ||
| Most of the settings you need to edit are in the ``/opt/redash/current/.env`` | ||
| file. If it doesn't exist, ``cp /opt/redash/current/.env.example /opt/redash/current/.env``. |
There was a problem hiding this comment.
The instructions assume you either use one of the provided images or the bootstrap script. The .env File will always be there and /opt/redash/current/.env is a symlink to /opt/redash/.env (so it's not lost when upgrading).
Note that for Docker you should not use the .env file but rather Docker's env variables.
No description provided.