Skip to content

Commit e0bc022

Browse files
author
Jesse
authored
Clarifying dev setup and Google Login (#620)
* Update developer docker instructions for .env file secret keys * Clarify google login behavior for visitors without existing accounts
1 parent f454e78 commit e0bc022

3 files changed

Lines changed: 23 additions & 3 deletions

File tree

src/pages/kb/open-source/admin-guide/env-vars-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: env-vars-settings
77

88
Many aspects of the functionality of Redash can be changes with settings.
99
Settings are read by `redash.settings` from environment variables which (for
10-
most installs) can be set in `/opt/redash/current/.env`.
10+
most installs) can be set in `/opt/redash/.env`.
1111

1212
The follow is a list of settings and what they control:
1313

src/pages/kb/open-source/dev-guide/docker.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,20 @@ git clone https://github.com/getredash/redash.git
2626
cd redash/
2727
```
2828

29-
### Update docker-compose.yml
29+
### Set up environment variables
3030

31-
Under the `x-redash-environment` key, uncomment the line containing `REDASH_COOKIE_SECRET` and specify a value.
31+
Create a `.env` file at the root and set any environment variables you need.
32+
33+
```
34+
$ touch .env
35+
```
36+
37+
{% callout info %}
38+
39+
An environment variable named `REDASH_COOKIE_SECRET` is required to run Redash. Read more why Redash uses secret keys [here]({% link _kb/open-source/admin-guide/secrets.md %})
40+
{% endcallout %}
41+
42+
You should include any relevant [environment variables]({% link _kb/open-source/admin-guide/env-vars-settings.md %}) in this file.
3243

3344
### Create Docker Services
3445

src/pages/kb/user-guide/users/authentication-options.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ Follow these steps to change the environment variables and UI settings to enable
3737
2. Set the **Authorized Redirect URL(s)** to `http(s)://${REDASH_BASEURL}/oauth/google_callback`.
3838
3. During setup you will obtain a client id and a client secret. Use these to set the `REDASH_GOOGLE_CLIENT_ID` and `REDASH_GOOGLE_CLIENT_SECRET` environment variables.
3939
4. Restart your Redash instance.
40+
41+
{% callout info %}
42+
43+
Step 5 below is optional. As of step 4, only visitors with an existing Redash account can sign-in using the Google Login flow. As with Password Login, visitors without an account cannot log-in unless they receive an invitation from an admin.
44+
45+
By following step 5, you may configure Redash to allow any user from a specified domain to log-in. An account will automatically be created for them if one does not already exist.
46+
47+
{% endcallout %}
48+
4049
5. Visit **Settings > General**. Complete the _Allowed Google Apps Domains_ box with the domains that should be able to log-in to your Redash instance.
4150

4251
# SAML 2.0

0 commit comments

Comments
 (0)