sso quickstart/docs: update configuration variables #226
Conversation
Codecov Report
@@ Coverage Diff @@
## master #226 +/- ##
=========================================
Coverage ? 62.25%
=========================================
Files ? 50
Lines ? 4069
Branches ? 0
=========================================
Hits ? 2533
Misses ? 1349
Partials ? 187 |
docs/google_provider_setup.md
Outdated
| @@ -122,7 +122,7 @@ have been filled in, click the "Authorize" button. | |||
| To give `sso-auth` permission to access Google Group information for users, the following | |||
| environment variables must be set: | |||
|
|
|||
| - **`GOOGLE_ADMIN_EMAIL`**: An administrative email address on your organization's | |||
| - **`PROVIDER_GOOGLE_GOOGLE_IMPERSONATE`**: An administrative email address on your organization's | |||
There was a problem hiding this comment.
The first GOOGLE here doesn't have to be GOOGLE -- it can be any unique identifier that logical groups a set of provider configs together. This is confusing but maybe figuring out a way to call out?
There was a problem hiding this comment.
Yeah..Let me note that specifically and try to make that a bit clearer - maybe just using a different unique identifier for the quickstart will help.
There was a problem hiding this comment.
@jphines - update the documentation to hopefully make this clearer
docs/quickstart.md
Outdated
| Add the below lines into the `env` file you just created: | ||
|
|
||
| PROVIDER_GOOGLE_TYPE=google | ||
| PROVIDER_GOOGLE_SLUG=google |
There was a problem hiding this comment.
Maybe we should make the identifier this slug instead of passing it in. Too magical?
There was a problem hiding this comment.
I like this idea. I don't personally feel like it's needed prior to the release (just in case anyone feels differently), but think it would be good to add!
There was a problem hiding this comment.
Just went through this last night with my existing dev instance that was several months outdated. After updating my env and docker-compose.yml following these updated instructions, everything worked as expected using google auth. I don’t have a way to test the Okta portion.
Jusshersmith
force-pushed
the
jusshersmith-update-docs
branch
from
1278716
to
de5c37f
Compare
Jusshersmith
requested review from
jphines and
benjsto
and removed request for
benjsto and
jphines
Problem
We’ve made some substantial changes to the configuration variables (largely their names, but also what’s optional) required by SSO. This means that the quickstart and other documentation is outdated.
Solution
This PR pulls our various documentation back in line with the configuration variables we now use. Most changes are applicable only to the ‘auth’ portion of SSO; the ‘proxy’ configuration variables have not yet been fully updated.