README.md 1.81 KB
Newer Older
David Seaward's avatar
David Seaward committed
1 2
Services middleware
===================
3

4
[project] | [code] | [tracker] | *snippets*
5

David Seaward's avatar
David Seaward committed
6 7
A middleware application for managing private, account-based services,
including resource management and user-facing registration. Tailored for
8 9
*Purist services* as offered by Purism SPC, but ready to be modified and
deployed anywhere, by anyone.
10 11 12 13 14

[project]: https://plan.puri.st/module/middleware
[code]: https://code.puri.sm/purist/middleware
[tracker]: https://code.puri.sm/purist/middleware/issues
[snippets]: https://code.puri.sm/purist/snippets/src/master/middleware
15

16 17
Installation
------------
18

19 20 21
Follows an opinionated installation process (specifically expecting
one-instance-per-server), but includes a number of configuration
options.
22

23
See [SETUP.md](SETUP.md) for prerequisites and instructions.
24 25 26 27

Usage
-----

28
* Start Django site as a system service, or with `./manage.py runserver`
29 30
* Visit <https://example.com> and follow the login or registration
  links.
31 32 33
  * If registration is closed, you will have to create LDAP credentials
    another way.
* Manage user profile at <https://example.com/accounts/profile/>
34

35 36 37 38 39 40 41
Models
------

![Database diagram generated by graph_models](models.png)

(Generated with `./manage.py graph_models --all-applications --group-models --verbose-name --output models.png`)

42 43
Sharing and contributions
-------------------------
44

David Seaward's avatar
David Seaward committed
45 46
Services middleware <br />
<https://plan.puri.st/module/middleware> <br />
47
Copyright 2017 Purism SPC and contributors <br />
48
SPDX-License-Identifier: AGPL-3.0+
49

50
Shared under AGPLv3-or-later, see [COPYING.AGPL.md](COPYING.AGPL.md)
51 52 53
for details. We adhere to the Contributor Covenant 1.4 without
modification, see [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
Contributions under the same terms are welcome.
54

55 56
Contributions and license notices from other sources are listed in
[COPYING.md](COPYING.md)