Keel - PSH Middleware
=====================

[project] | [code] | [tracker]

A Django-based middleware application (with a user-facing web interface) for managing services, resources and
subscription-based accounts on a Purist Services Host (PSH). Tailored for services operated by Purism SPC, but ready to
be modified and deployed anywhere, by anyone.

Installation
------------

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

See [SETUP.md] for prerequisites and instructions.

Usage
-----

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

Models
------

![Database model diagram](models.png)

Model diagram generated with:

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

Sharing and contributions
-------------------------

Keel - PSH Middleware  
<https://source.puri.sm/liberty/psh_middleware>  
Copyright 2017-2018 Purism SPC  
SPDX-License-Identifier: AGPL-3.0-or-later

Shared under AGPL-3.0-or-later. We adhere to the Contributor Covenant
1.4 without modification, and certify origin per DCO 1.1 with a
signed-off-by line. Contributions under the same terms are welcome.

For details see:

* [COPYING.md], license notices
* [COPYING.AGPL.md], full license text
* [CODE_OF_CONDUCT.md], full conduct text
* [CONTRIBUTING.DCO.md], full origin text

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

<!-- Links -->

[project]: https://source.puri.sm/liberty/psh_middleware
[code]: https://source.puri.sm/liberty/psh_middleware/tree/master
[tracker]: https://source.puri.sm/liberty/psh_middleware/issues
[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
