From 80bcd09cec609933def44c4ddbc1140e21b1afe0 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Sun, 11 Apr 2021 14:08:05 +0200 Subject: [PATCH] docs: add headers set by proxy outpost Signed-off-by: Jens Langhammer --- website/docs/outposts/proxy.md | 16 ++++++++++++++++ website/sidebars.js | 1 + 2 files changed, 17 insertions(+) create mode 100644 website/docs/outposts/proxy.md diff --git a/website/docs/outposts/proxy.md b/website/docs/outposts/proxy.md new file mode 100644 index 000000000..2b3ed998e --- /dev/null +++ b/website/docs/outposts/proxy.md @@ -0,0 +1,16 @@ +--- +title: Proxy Outpost +--- + +The proxy outpost sets the following headers: + +``` +X-Auth-Username: akadmin # The username of the currently logged in user +X-Forwarded-Email: root@localhost # The email address of the currently logged in user +X-Forwarded-Preferred-Username: akadmin # The username of the currently logged in user +X-Forwarded-User: 900347b8a29876b45ca6f75722635ecfedf0e931c6022e3a29a8aa13fb5516fb # The hashed identifier of the currently logged in user. +``` + +Additionally, you can set `additionalHeaders` on groups or users to set additional headers. + +If you enable *Set HTTP-Basic Authentication* option, the HTTP Authorization header is being set. diff --git a/website/sidebars.js b/website/sidebars.js index 201621826..3add7fc2e 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -34,6 +34,7 @@ module.exports = { label: "Outposts", items: [ "outposts/outposts", + "outposts/proxy", "outposts/upgrading", "outposts/manual-deploy-docker-compose", "outposts/manual-deploy-kubernetes",