aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 84a19c0aa4d384dc13169d1a850ca219379258af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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 <https://www.gnu.org/licenses/agpl.html>.