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: unify oidc guides using tabs #9068

Merged
merged 4 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -171,15 +171,8 @@ module.exports = {
{
"Frontend Authentication": [
"docs/authentication/guides/jaas",
{
"OIDC Authentication": [
"docs/authentication/guides/sso/configure-oidc-react",
"docs/authentication/guides/sso/configure-oidc-react-google",
"docs/authentication/guides/sso/configure-oidc-react-okta",
"docs/authentication/guides/sso/configure-oidc-react-azure",
"docs/authentication/guides/sso/configure-oidc-behind-proxy",
],
},
"docs/authentication/guides/sso/configure-oidc-react",
"docs/authentication/guides/sso/configure-oidc-behind-proxy",
],
},
"docs/authentication/introducing-metadata-service-authentication",
Expand Down
18 changes: 10 additions & 8 deletions docs/authentication/guides/sso/configure-oidc-behind-proxy.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Configuring Frontend to use a Proxy when communicating with SSO Provider
*Authored on 22/08/2023*
# OIDC Proxy Configuration

The `datahub-frontend-react` server can be configured to use an http proxy when retrieving the openid-configuration.
This can be needed if your infrastructure is locked down and disallows connectivity by default, using proxies for fine-grained egress control.
_Authored on 22/08/2023_

The `datahub-frontend-react` server can be configured to use an http proxy when retrieving the openid-configuration.
This can be needed if your infrastructure is locked down and disallows connectivity by default, using proxies for fine-grained egress control.

## Configure http proxy and non proxy hosts

Expand All @@ -17,7 +18,8 @@ HTTP_NON_PROXY_HOSTS=localhost|datahub-gms (or any other hosts that you would li
```

## Optional: provide custom truststore
If your upstream proxy performs SSL termination to inspect traffic, this will result in different (self-signed) certificates for HTTPS connections.

If your upstream proxy performs SSL termination to inspect traffic, this will result in different (self-signed) certificates for HTTPS connections.
The default truststore used in the `datahub-frontend-react` docker image will not trust these kinds of connections.
To address this, you can copy or mount your own truststore (provided by the proxy or network administrators) into the docker container.

Expand All @@ -36,8 +38,8 @@ FROM linkedin/datahub-frontend-react:<version>
COPY /truststore-directory /certificates
```

Building this Dockerfile will result in your own custom docker image on your local machine.
You will then be able to tag it, publish it to your own registry, etc.
Building this Dockerfile will result in your own custom docker image on your local machine.
You will then be able to tag it, publish it to your own registry, etc.

#### Option b) Mount truststore from your host machine using a docker volume

Expand All @@ -51,7 +53,7 @@ Adapt your docker-compose.yml to include a new volume mount in the `datahub-fron
- /truststore-directory:/certificates
```

### Reference new truststore
### Reference new truststore

Add the following environment values to the `datahub-frontend-react` container:

Expand Down
127 changes: 0 additions & 127 deletions docs/authentication/guides/sso/configure-oidc-react-azure.md

This file was deleted.

118 changes: 0 additions & 118 deletions docs/authentication/guides/sso/configure-oidc-react-google.md

This file was deleted.

Loading
Loading