pierre/BasicOIDC
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details

Browse Source
This commit is contained in:
Pierre HUBERT 2024-03-28 18:06:28 +01:00
parent 7060ce3fe4
commit 5a0f27271e
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -13,10 +13,15 @@ BasicOIDC operates without any database, just with three files :
## Configuration ## Configuration
You can configure a list of clients (Relying Parties) in a `clients.yaml` file with the following syntax : You can configure a list of clients (Relying Parties) in a `clients.yaml` file with the following syntax :
```yaml ```yaml
# Client ID
- id: gitea - id: gitea
# Client name
name: Gitea name: Gitea
# Client description
description: Git with a cup of tea 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 secret: TOP_SECRET
# The URL where user shall be redirected after authentication
redirect_uri: https://mygit.mywebsite.com/ redirect_uri: https://mygit.mywebsite.com/
# If you want new accounts to be granted access to this client by default # If you want new accounts to be granted access to this client by default
default: true default: true
@ -32,6 +37,7 @@ In order to run BasicOIDC for development, you will need to create a least an em
## Features ## Features
* [x] `authorization_code` flow * [x] `authorization_code` flow
* [x] `implicit` flow
* [x] Client authentication using secrets * [x] Client authentication using secrets
* [x] Bruteforce protection * [x] Bruteforce protection
* [x] 2 factors authentication * [x] 2 factors authentication