From 9a05ee940d95c90b6e9e1b37a9822551ada18cc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ag=C3=B3cs=20D=C3=A1niel?= <agocsdaniel@gmail.com> Date: Sun, 24 May 2020 13:13:10 +0200 Subject: [PATCH] Updated docs --- README.md | 6 ++++++ docs/2_auth.md | 16 ++++++++++++++++ docs/configuration/configuration.md | 1 + 3 files changed, 23 insertions(+) diff --git a/README.md b/README.md index d912fa7..18ea569 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@  +AuthSCH támogatással + +Docker image a [KSZK Registry](https://nexus.kszk.bme.hu)ben +Pullold SCHAcc belépés után a `registry.kszk.bme.hu/oauth2_proxy_authsch` image-t. +Bővebb infó [itt](docs/2_auth.md). + [](http://travis-ci.org/oauth2-proxy/oauth2-proxy) [](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy) diff --git a/docs/2_auth.md b/docs/2_auth.md index 851bde5..d0226ef 100644 --- a/docs/2_auth.md +++ b/docs/2_auth.md @@ -25,11 +25,27 @@ Valid providers are : - [DigitalOcean](#digitalocean-auth-provider) - [Bitbucket](#bitbucket-auth-provider) - [Gitea](#gitea-auth-provider) +- [Auth.SCH](#authsch-auth-provider) The provider can be selected using the `provider` configuration value. Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the OpenID Connect provider. +### Auth.SCH Auth Provider + +1. Csinálj magadnak kliens ID-t az https://admin.sch.bme.hu oldalon a fejlesztői konzolban +2. Callback URL-nek a webroot/oauth2/callback címet állítsd be, pl: https://domainnev.hu/oauth2/callback +3. Állítsd be a proxyt: +``` +--provider=authsch +--client-id=<KLIENS ID> +--client-secret=<KLIENS SECRET> +``` +4. Van lehetőség AD group matchelésre is: +``` +--authsch-group=<AD group> +``` + ### Google Auth Provider For Google, the registration steps are: diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index 69b3cfa..ecc78cc 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -27,6 +27,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example | `--auth-logging` | bool | Log authentication attempts | true | | `--auth-logging-format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) | | `--authenticated-emails-file` | string | authenticate against emails via file (one per line) | | +| `--authsch-group` | string | Auth.SCH AD group matching | `""` means any gorup | | `--azure-tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` | | `--basic-auth-password` | string | the password to set when passing the HTTP Basic Auth header | | | `--client-id` | string | the OAuth Client ID: ie: `"123456.apps.googleusercontent.com"` | | -- GitLab