Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add quickstart & document google provider setup #23

Merged
merged 3 commits into from
Aug 23, 2018

Conversation

mccutchen
Copy link
Contributor

This builds on @danbf and @katzdm's work in #18 to provide:

  • Standalone documentation of the Google provider setup process
  • A relatively simple quickstart process that uses docker-compose to spin up an example deployment of sso and two secured upstream services

RFR @buzzfeed/infra-security

It is used to provide single-sign-on authentication and authorization for internal web applications behind it by ensuring that only people in a specific email domain (and optionally users in specific Google Groups) can access them. It consists of two processes - `sso-auth` and `sso-proxy`.
It depends on Google as its authoritative OAuth2 provider, and authenticates
users against a specific email domain. Further authorization based on Google
Group membership can be required on a per-upstream basis.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tweaked the README here because there was some redundancy in the opening two paragraphs, which both gave a brief intro to what sso is!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

# ===========================================================================
sso-proxy:
image: buzzfeed/sso:latest # change this to `build: ..` to try local changes
entrypoint: /bin/sso-proxy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need working_dir: /go/src/github.com/buzzfeed/sso/ here to handle the static css properly?

i get this fail without it

screen shot 2018-08-23 at 10 35 06 am

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danbf I'm pretty sure this is an indication that you're not actually running the latest docker image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nvm, yup: this fixed it docker rm -f $(docker ps -aq); docker rmi -f $(docker image list -q)


sso-auth:
image: buzzfeed/sso:latest # change this to `build: ..` to try local changes
entrypoint: /bin/sso-auth
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need working_dir: /go/src/github.com/buzzfeed/sso/ here to handle the static css properly?

i get this fail without it

screen shot 2018-08-23 at 10 35 06 am

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nvm, yup: this fixed it docker rm -f $(docker ps -aq); docker rmi -f $(docker image list -q)

- 'sso-auth.localtest.me:172.20.0.1'

sso-auth:
image: buzzfeed/sso:latest # change this to `build: ..` to try local changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we set this to buzzfeed/sso:release-1.0.0 ?

# - http://httpbin.sso.localtest.me
# ===========================================================================
sso-proxy:
image: buzzfeed/sso:latest # change this to `build: ..` to try local changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we set this to buzzfeed/sso:release-1.0.0 ?

- **Service account name**: Any appropriate name is fine. We recommend `sso-authenticator`.
- **Service account ID**: Google will generate this as you type the "account name". We recommend
leaving as-is.
- **Project rol**: No project roles are required for `sso`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Project role missing e

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good eye, fixed!

katzdm and others added 3 commits August 23, 2018 07:55
This uses docker-compose to spin up an example deployment of sso
and two protected upstreams.
Copy link
Contributor

@danbf danbf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@danbf danbf merged commit f9af1ca into master Aug 23, 2018
@danbf danbf deleted the quickstart-tweaks branch August 23, 2018 15:01
@danbf danbf mentioned this pull request Aug 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants