Infrastructure/zipline
1
Fork 0
Code Issues Pull requests Activity

Update README.md

Browse source
This commit is contained in:
Korbs 2024-12-19 16:28:02 -05:00
parent f1150fa5ad
commit d874a43a7d
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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.
<div align="center">
<img src="https://raw.githubusercontent.com/diced/zipline/trunk/public/zipline_small.png"/>