mirror of
https://github.com/oauth2-proxy/oauth2-proxy.git
synced 2026-09-30 03:31:27 +02:00
Pierluigi LenociandJan Larwig
3c22bc7877
* docs: add Kubernetes Dashboard integration guide for Azure Entra ID Add comprehensive documentation for integrating oauth2-proxy with Kubernetes Dashboard on Azure Kubernetes Service (AKS) using Azure Entra ID authentication. Changes: - Add new section "Kubernetes Dashboard on AKS" to ms_entra_id.md with complete configuration examples including: - Architecture overview and integration flow - Alpha configuration for oauth2-proxy Helm chart - Dashboard Ingress with proper auth annotations - RBAC configuration (user-based and group-based) - Troubleshooting guide for common issues - Workload Identity (passwordless) setup - Add reference link in integration.md pointing to the new section for users looking for Kubernetes Dashboard integration examples This addresses common issues users face when integrating Dashboard with Entra ID, particularly: - Missing Authorization header in auth-response-headers - Insufficient buffer sizes for large Entra ID tokens - RBAC permission configuration - Group claims setup Closes: oauth2-proxy/manifests#348 Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com> * docs: split integration.md into separate integration guides Split the monolithic integration.md file into a structured integrations directory with individual pages for each tool as requested by maintainer. Changes: - Create new docs/configuration/integrations/ directory structure - Split content into separate files: - nginx.md: Nginx auth_request directive configuration - traefik.md: Traefik v2 ForwardAuth middleware setup - caddy.md: Caddy v2 forward_auth directive configuration - kubernetes-dashboard.md: K8s Dashboard integration (with deprecation notice) - headlamp.md: Headlamp integration guide (recommended alternative) - Transform integration.md into an index/overview page linking to all integrations - Update docs/sidebars.js to use new Integration Guides category structure The content has been preserved as-is from the original file, only reorganized into separate files for better maintainability and navigation. Added deprecation notice for Kubernetes Dashboard per https://github.com/kubernetes/dashboard/commit/0ba796dce6916bb6ca5da5ca0b3ab22cecfd1e18 Addresses maintainer feedback from PR #3299 Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com> * fix: restore Kubernetes Dashboard tip box in nginx integration docs Add back the tip box referencing the Kubernetes Dashboard Azure Entra ID integration example that was present in the original integration.md file. This ensures all content from the original file is preserved in the split documentation structure. Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com> * refactor: move Kubernetes Dashboard details to integration guide Move the detailed Kubernetes Dashboard integration content from the ms_entra_id provider documentation to the integrations section where it logically belongs. Changes: - Move complete K8s Dashboard guide from ms_entra_id.md to integrations/kubernetes-dashboard.md (architecture, configuration, RBAC, troubleshooting, Workload Identity) - Replace detailed section in ms_entra_id.md with brief reference to integration guide - Reorder sidebar: Headlamp before Kubernetes Dashboard - Update integration.md index to show Headlamp first (recommended), Dashboard last (deprecated) This improves documentation organization by keeping integration guides in the integrations/ directory and provider docs focused on provider configuration. Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com> * docs: move integration.md to integrations/index.md Signed-off-by: Jan Larwig <jan@larwig.com> --------- Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com> Signed-off-by: Jan Larwig <jan@larwig.com> Co-authored-by: Jan Larwig <jan@larwig.com>
98 lines
2.6 KiB
JavaScript
98 lines
2.6 KiB
JavaScript
const sidebars = {
|
|
docs: [
|
|
{
|
|
type: 'doc',
|
|
id: 'welcome',
|
|
},
|
|
{
|
|
type: 'doc',
|
|
id: 'installation',
|
|
},
|
|
{
|
|
type: 'doc',
|
|
id: 'behaviour',
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Configuration',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'configuration/overview',
|
|
},
|
|
collapsed: false,
|
|
items: [
|
|
'configuration/overview',
|
|
{
|
|
type: 'category',
|
|
label: 'Integration Guides',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'configuration/integrations/index',
|
|
},
|
|
items: [
|
|
"configuration/integrations/nginx",
|
|
"configuration/integrations/traefik",
|
|
"configuration/integrations/caddy",
|
|
"configuration/integrations/headlamp",
|
|
"configuration/integrations/kubernetes-dashboard"
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'OAuth Provider Configuration',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'configuration/providers/index',
|
|
},
|
|
items: [
|
|
"configuration/providers/adfs",
|
|
"configuration/providers/azure",
|
|
"configuration/providers/bitbucket",
|
|
"configuration/providers/cidaas",
|
|
"configuration/providers/cisco_duo",
|
|
"configuration/providers/digitalocean",
|
|
"configuration/providers/facebook",
|
|
"configuration/providers/gitea",
|
|
"configuration/providers/github",
|
|
"configuration/providers/gitlab",
|
|
"configuration/providers/google",
|
|
"configuration/providers/keycloak",
|
|
"configuration/providers/keycloak_oidc",
|
|
"configuration/providers/linkedin",
|
|
"configuration/providers/login_gov",
|
|
"configuration/providers/ms_entra_id",
|
|
"configuration/providers/nextcloud",
|
|
"configuration/providers/openid_connect",
|
|
"configuration/providers/sourcehut"
|
|
],
|
|
},
|
|
'configuration/session_storage',
|
|
'configuration/tls',
|
|
'configuration/alpha-config',
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Features',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'features/endpoints',
|
|
},
|
|
collapsed: false,
|
|
items: ['features/endpoints'],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Community',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'community/security',
|
|
},
|
|
collapsed: false,
|
|
items: ['community/contribution', 'community/security'],
|
|
},
|
|
],
|
|
};
|
|
|
|
export default sidebars;
|