From ef14ba500ff27dd2d1fe6e5debd99f7a5fc4db10 Mon Sep 17 00:00:00 2001 From: winter Sparkles Date: Thu, 6 Aug 2026 23:47:34 +0100 Subject: initial commit --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..00bf3ba --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Pleasant SSO + +Pleasant SSO is a nice little single-sign-on server, aimed at small deployments +that don't need the massive complexity of larger enterprise solutions. + +It's new and currently useless! But, we have these goals for it: + +- support both single-domain and multi-domain situations, where there is one + primary domain, but potentially more than one secondary domain that also needs + to have its cookies set appropriately + +- be extensible, so that you can add new auth methods relatively easily (and + have the most common ones available out of the box, including password, + passkey, TOTP, FIDO2) + +- be configurable, so that you can select auth methods in whichever order and + with whichever number of factors suits you + +- be easy to integrate with common setups for SSO, and also be an auth provider + in other ways (e.g. OpenID and IndieAuth) + +And these non-goals: + +- super complicated user configuration (i.e. it'll be good for a small group of + people who generally trust each other, probably not so much for a large + company) + +## Installation + +Don't. (but if you must, it currently just requires php >= 8.4 with the usual +extensions and also the less usual xsl extension as it uses XSLTProcessor for +templates) + +## Copyright + +Pleasant SSO is copyright © winter Sparkles (and other contributors, in the +event that we receive contributions, but this hasn't happened yet), and is made +available under the terms of the GNU AGPLv3 or later, which you can find in the +file [COPYING](COPYING) or online at +. -- cgit v1.3