README.md 2.06 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
Installation
------------
13

14 15 16
Follows an opinionated installation process (specifically expecting
one-instance-per-server), but includes a number of configuration
options.
17

18
See [SETUP.md] for prerequisites and instructions.
19 20 21 22

Usage
-----

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

30 31 32
Models
------

33
![Database model diagram](models.png)
34

35 36 37 38
Model diagram generated with:

    ./manage.py graph_models --all-applications --group-models \
    --verbose-name --output models.png
39

40 41
Sharing and contributions
-------------------------
42

43 44 45
Services middleware  
<https://source.puri.sm/purist/middleware>  
Copyright 2017-2018 Purism SPC  
46
SPDX-License-Identifier: AGPL-3.0+
47

48 49 50 51 52
Shared under AGPLv3-or-later. We adhere to the Contributor Covenant 1.4
without modification. Signed contributions (`git commit -s`) under the
same terms are welcome.

For details see:
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
* [COPYING.AGPL.md], full license text
* [COPYING.md], additional license notices
* [CODE_OF_CONDUCT.md], full conduct text
* [CONTRIBUTING.DCO.md], full contribution text
* [CONTRIBUTING.md], additional contribution notes

<!-- Links -->

[project]: https://source.puri.sm/purist/middleware
[code]: https://source.puri.sm/purist/middleware
[tracker]: https://source.puri.sm/purist/middleware/issues
[snippets]: https://code.puri.sm/purist/snippets/src/master/middleware
[SETUP.md]: SETUP.md
[COPYING.AGPL.md]: COPYING.AGPL.md
[CODE_OF_CONDUCT.md]: CODE_OF_CONDUCT.md
[CONTRIBUTING.DCO.md]: CONTRIBUTING.DCO.md
[COPYING.md]: COPYING.md
[CONTRIBUTING.md]: CONTRIBUTING.md