README.md 2.09 KB
Newer Older
1 2
Keel
====
3

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

6
A Django-based middleware application (with a user-facing web interface) for managing services, resources and
7 8
subscription-based accounts on a Liberty Sailplan Host (LSH). The reference implementation for LSH middleware. Tailored
for services operated by Purism SPC, but ready to be modified and deployed anywhere, by anyone.
9

10 11
Installation
------------
12

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

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

Usage
-----

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

29 30 31
Models
------

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

34 35 36 37
Model diagram generated with:

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

39 40
Sharing and contributions
-------------------------
41

42 43
Keel (LSH middleware)  
<https://source.puri.sm/liberty/lsh_middleware>  
44
Copyright 2017-2018 Purism SPC  
45
SPDX-License-Identifier: AGPL-3.0-or-later
46

47 48
Shared under AGPL-3.0-or-later. We adhere to the Community Covenant
1.0 without modification, and certify origin per DCO 1.1 with a
49
signed-off-by line. Contributions under the same terms are welcome.
50 51

For details see:
52

53
* [COPYING.md], license notices
54 55
* [COPYING.AGPL.md], full license text
* [CODE_OF_CONDUCT.md], full conduct text
56 57 58
* [CONTRIBUTING.DCO.md], full origin text

<!-- * [CONTRIBUTING.md], additional contribution notes -->
59 60 61

<!-- Links -->

62 63 64
[project]: https://source.puri.sm/liberty/lsh_middleware
[code]: https://source.puri.sm/liberty/lsh_middleware/tree/master
[tracker]: https://source.puri.sm/liberty/lsh_middleware/issues
65 66 67 68 69 70
[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