From d874a43a7dc91fdf3639a8924b72d7f985b9dc06 Mon Sep 17 00:00:00 2001 From: Korbs Date: Thu, 19 Dec 2024 16:28:02 -0500 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ea776e..f501e22 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ > This is a fork of Zipline created by the GitHub user known as [Danejur](https://github.com/danejur), which adds the function to enable OpenID Connect method for authentication. This helps Zipline meet the requirements for SudoVanilla's on-premise policy. > [!NOTE] -> While this is a fork of Zipline by Danejur, SudoVanilla [made only one change](https://ark.sudovanilla.org/Infrastructure/zipline/src/branch/feature/oauth-authentik/src/pages/api/auth/oauth/authentik.ts#L69). In order for this fork to work nicely with SudoVanilla Gateway, more specifically LogTo, during registration it'll use your email instead of a username for your Zipline username. This is because for whatever reason, the registration during the Gateway sign-up, a username option was not given. This means your username would of been "undefined" with the original fork. +> In order for this fork to work nicely with SudoVanilla Gateway, more specifically LogTo, during registration it'll use your email instead of a username for your Zipline username. This is because for whatever reason, the registration during the Gateway sign-up, a username option was not given. This means your username would of been "undefined" with the original fork. So, SudoVanilla made changes to make the registration use your `email` instead of the `preferred_username`, [see here](https://ark.sudovanilla.org/Infrastructure/zipline/src/branch/feature/oauth-authentik/src/pages/api/auth/oauth/authentik.ts#L69) + +> [!NOTE] +> Other changes made were to only allow users to login or register via the SudoVanilla Gateway. The login page was modified to remove the entire login form and show only the SudoVanilla Gateway button. View commit history since December 18th to see all further changes made.