> 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.
> 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.
The website below provides documentation for more up-to-date features with the upstream branch. The normal documentation is for the latest release and is not updated unless a new release is made.
After installing, please edit the `docker-compose.yml` file and find the line that says `SECRET=changethis` and replace `changethis` with a random string.
Ways you could generate the string could be from a password managers generator, or you could just slam your keyboard and hope for the best.
The default port is `3000`, once you have accessed it you can see a login screen. The default credentials are "administrator" and "password". Once you login please immediately change the details to something more secure. You can do this by clicking on the top right corner where it says "administrator" with a gear icon and clicking Manage Account.
After navigating to Zipline, click on the top right corner where it says your username and click Manage Account. Scroll down to see "ShareX Config", select the one you would prefer using. After this you can import the .sxcu into sharex. [More information here](https://zipl.vercel.app/docs/guides/uploaders/sharex)
If using wayland you will need to have [wl-clipboard](https://github.com/bugaevc/wl-clipboard) installed, for the `wl-copy` command.
If you are not using GNOME/KDE/Qtile/Sway, and are using something like a wlroots-based compositor (ex. [Hyprland](https://github.com/hyprwm/Hyprland/), [River](https://github.com/riverwm/river), etc), you will need to set the `XDG_CURRENT_DESKTOP` environment variable to `sway`, which will just override it for this script. Adding `export XDG_CURRENT_DESKTOP=sway` to the start of the script will work.
After this, replace the `xsel -ib` with `wl-copy` in the script.
To upload files using flameshot we will use a script. Replace $TOKEN and $HOST with your own values, you probably know how to do this if you use linux.
Create a pull request on GitHub. If your PR does not pass the action checks, then please fix the errors. If your PR was submitted before a release, and I have pushed a new release, please make sure to update your PR to reflect any changes, usually this is handled by GitHub.
