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

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

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

12 13
Installation
------------
14

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

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

Usage
-----

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

31 32 33
Models
------

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

36 37 38 39
Model diagram generated with:

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

41 42
Sharing and contributions
-------------------------
43

44 45
Keel (LDH middleware)  
<https://source.puri.sm/liberty/ldh_middleware>  
46
Copyright 2017-2018 Purism SPC  
47
SPDX-License-Identifier: AGPL-3.0-or-later
48

49 50
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
51
signed-off-by line. Contributions under the same terms are welcome.
52 53

For details see:
54

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

<!-- * [CONTRIBUTING.md], additional contribution notes -->
61 62 63

<!-- Links -->

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