diff --git a/README.md b/README.md index 757722f..13ffeac 100644 --- a/README.md +++ b/README.md @@ -80,31 +80,31 @@ app app secret insert git.example.coop signing_private_key v1 -f ~/.ssh/id_ed255 app app deploy git.example.coop ``` -## Set-up Keycloak authentication +## Keycloak integration This example uses https://git.coop.tech and https://keycloak.coop.tech as an example. Replace them with your own domains: -### Settings in keycloak +### In keycloak - If you haven't already done so for other services, create a realm. - Within that realm, create a client. - - Client type = OpenID Connect - - Client ID = forgejo - - Client authentication -> on - - Authorization -> on - - Standard flow -> ✅ - - Direct access grants -> ✅ - - Valid redirect URIs = https://git.coop.tech/* - - Valid post logout redirect URIs = https://git.coop.tech/* + - Client type = `OpenID Connect` + - Client ID = `forgejo` + - Client authentication ✅ + - Authorization ✅ + - Standard flow ✅ + - Direct access grants ✅ + - Valid redirect URIs = `https://git.coop.tech/*` + - Valid post logout redirect URIs = `https://git.coop.tech/*` - Note the client secret under "clients" -> "credentials" -### Settings in forgejo +### In Forgejo - Go to https://git.coop.tech/admin -- Go to Identity & access -- Go to Authentication sources -- Authentication type: OAuth2 -- OAuth2 provider: OpenID Connect -- Client ID = forgejo +- Go to "Identity & access" +- Go to "Authentication sources" +- Authentication type: `OAuth2` +- OAuth2 provider: `OpenID Connect` +- Client ID = `forgejo` - Client secret = #see client secrete mentioned above -- OpenID Connect Auto Discovery URL = https://keycloak.coop.tech/realms//.well-known/openid-configuration +- OpenID Connect Auto Discovery URL = `https://keycloak.coop.tech/realms//.well-known/openid-configuration`