From 5a0f27271e7df1d109ee2e9739a808c1f4a870b5 Mon Sep 17 00:00:00 2001 From: Pierre HUBERT Date: Thu, 28 Mar 2024 18:06:28 +0100 Subject: [PATCH] Update README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 96a08c4..16b201e 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,15 @@ BasicOIDC operates without any database, just with three files : ## Configuration You can configure a list of clients (Relying Parties) in a `clients.yaml` file with the following syntax : ```yaml + # Client ID - id: gitea + # Client name name: Gitea + # Client description description: Git with a cup of tea + # Client secret. Specify this value to use authorization code flow, remove it for implicit authentication flow secret: TOP_SECRET + # The URL where user shall be redirected after authentication redirect_uri: https://mygit.mywebsite.com/ # If you want new accounts to be granted access to this client by default default: true @@ -32,6 +37,7 @@ In order to run BasicOIDC for development, you will need to create a least an em ## Features * [x] `authorization_code` flow +* [x] `implicit` flow * [x] Client authentication using secrets * [x] Bruteforce protection * [x] 2 factors authentication