From 37dcf264e51c7c93bea345ac84ecd9e5fc1114c1 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Wed, 9 Sep 2020 19:21:36 +0200 Subject: [PATCH] docs: add docs for proxy provider --- docs/build.sh | 3 --- docs/providers/proxy.md | 13 +++++++++++++ docs/upgrading/to-0.10.md | 2 ++ mkdocs.yml | 1 + 4 files changed, 16 insertions(+), 3 deletions(-) delete mode 100755 docs/build.sh create mode 100644 docs/providers/proxy.md diff --git a/docs/build.sh b/docs/build.sh deleted file mode 100755 index 3ca164253..000000000 --- a/docs/build.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash -x -pip install -U mkdocs mkdocs-material -mkdocs gh-deploy diff --git a/docs/providers/proxy.md b/docs/providers/proxy.md new file mode 100644 index 000000000..000f1de88 --- /dev/null +++ b/docs/providers/proxy.md @@ -0,0 +1,13 @@ +# Proxy Provider + +This provider protects applications, which have no built-in support for OAuth2 or SAML. This is done by running a lightweight Reverse Proxy in front of the application, which authenticates the requests. + +passbook Proxy is based on [oauth2_proxy](https://github.com/oauth2-proxy/oauth2-proxy), but has been integrated more tightly with passbook. + +The Proxy these extra headers to the application: + +Header Name | Value +-------------|------- +X-Auth-Request-User | The user's unique identifier +X-Auth-Request-Email | The user's email address +X-Auth-Request-Preferred-Username | The user's username diff --git a/docs/upgrading/to-0.10.md b/docs/upgrading/to-0.10.md index dd848f488..658da1c22 100644 --- a/docs/upgrading/to-0.10.md +++ b/docs/upgrading/to-0.10.md @@ -10,6 +10,8 @@ This update brings a lot of big features, such as: Due to this new OAuth2 Provider, the Application Gateway Provider, now simply called "Proxy Provider" has been revamped as well. The new passbook Proxy integrates more tightly with passbook via the new Outposts system. The new proxy also supports multiple applications per proxy instance, can configure TLS based on passbook Keypairs and more. + See [Proxy](../providers/proxy.md) + - Outpost System This is a new Object type, used currently only by the Proxy Provider. It manages the creation and permissions of service accounts, which are used by the outposts to communicate with passbook. diff --git a/mkdocs.yml b/mkdocs.yml index c50ee983f..911db8d81 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,6 +29,7 @@ nav: - Providers: - OAuth2: providers/oauth2.md - SAML: providers/saml.md + - Proxy: providers/proxy.md - Expressions: - Overview: expressions/index.md - Reference: