Commit 27c95fe9 authored by David Seaward's avatar David Seaward

adopt contributor covenant 1.4 (and clean up .md files)

parent 49fa8c3f
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <purist@puri.sm>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org
...@@ -18,19 +18,68 @@ GNU Affero General Public License for more details. ...@@ -18,19 +18,68 @@ GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
## Other notices ## Notices for dependencies
All code is covered by the "Copying notice" above. All code is covered by and compatible with the "Copying notice" above.
Dependencies may have their own notices. These can be found in the
source code of those dependencies.
Some code copied from other sources comes with additional notices. Dependencies are listed in `README.md` and `requires/requirements.txt`
These are listed below. These notices are also listed in the files were
the code appears.
Notices for dependencies can be found in those dependencies.
## Notices for included code ## Notices for included code
Code from django-registration-templates (RatanShreshtha fork) <br /> All code is covered by and compatible with the "Copying notice" above.
Some code copied from other sources comes with additional notices. These
are listed below, and also appear in the files where that code appears.
---
Celery (code from Celery) <br />
https://github.com/celery/celery/blob/master/extra/supervisord/celerybeat.conf <br />
Copyright 2009-2012, 2015-2016 Ask Solem and contributors <br />
Copyright 2012-2014 GoPivotal, Inc <br />
SPDX-License-Identifier: BSD 3-Clause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Ask Solem, nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Ask Solem OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
---
Contributor Covenant <br />
https://www.contributor-covenant.org <br />
Copyright 2014-2017 Coraline Ada Ehmke and contributors <br />
SPDX-License-Identifier: CC-BY-4.0
This Code of Conduct is adapted from the
[Contributor Covenant][homepage], version 1.4, available at
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org
---
django-registration-templates (code from RatanShreshtha fork of django-registration-templates) <br />
https://github.com/RatanShreshtha/django-registration-templates <br /> https://github.com/RatanShreshtha/django-registration-templates <br />
Copyright 2015 Anders Hofstee and contributors <br /> Copyright 2015 Anders Hofstee and contributors <br />
SPDX-License-Identifier: MIT SPDX-License-Identifier: MIT
...@@ -55,7 +104,7 @@ SOFTWARE. ...@@ -55,7 +104,7 @@ SOFTWARE.
--- ---
Code from PyLDAP ORM <br /> PyLDAP ORM (code from PyLDAP ORM) <br />
https://github.com/asyd/pyldap_orm/blob/master/pyldap_orm/controls.py <br /> https://github.com/asyd/pyldap_orm/blob/master/pyldap_orm/controls.py <br />
Copyright 2016 Bruno Bonfils <br /> Copyright 2016 Bruno Bonfils <br />
SPDX-License-Identifier: Apache-2.0 SPDX-License-Identifier: Apache-2.0
...@@ -71,34 +120,3 @@ distributed under the License is distributed on an "AS IS" BASIS, ...@@ -71,34 +120,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
---
Code from Celery <br />
https://github.com/celery/celery/blob/master/extra/supervisord/celerybeat.conf <br />
Copyright 2009-2012, 2015-2016 Ask Solem and contributors, 2012-2014 GoPivotal, Inc <br />
SPDX-License-Identifier: BSD 3-Clause
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Ask Solem, nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Ask Solem OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
...@@ -5,63 +5,35 @@ Services middleware ...@@ -5,63 +5,35 @@ Services middleware
A middleware application for managing private, account-based services, A middleware application for managing private, account-based services,
including resource management and user-facing registration. Tailored for including resource management and user-facing registration. Tailored for
*Purist services* offered by Purism SPC, but deployable anywhere. *Purist services* as offered by Purism SPC, but ready to be modified and
deployed anywhere, by anyone.
Follows an opinionated installation process (specifically expecting
one-instance-per-server), but also includes a number of configuration
options.
[project]: https://plan.puri.st/module/middleware [project]: https://plan.puri.st/module/middleware
[code]: https://code.puri.sm/purist/middleware [code]: https://code.puri.sm/purist/middleware
[tracker]: https://code.puri.sm/purist/middleware/issues [tracker]: https://code.puri.sm/purist/middleware/issues
[snippets]: https://code.puri.sm/purist/snippets/src/master/middleware [snippets]: https://code.puri.sm/purist/snippets/src/master/middleware
Prerequisites Installation
------------- ------------
* Debian 9 Follows an opinionated installation process (specifically expecting
* Python 3.5 one-instance-per-server), but includes a number of configuration
* Django 1.11 (included in Python packages below) options.
* Nginx
* RabbitMQ server
* Must be accessible at `amqp://guest:guest@localhost:5672//`
* This can be achieved with just `apt install rabbitmq-server`
* Additional dependencies (Debian package names):
* `libsasl2-dev`
* `libldap2-dev`
* `libssl-dev`
* `python3-dev`
* `supervisor`
* `uwsgi`
* `uwsgi-emperor`
* `uwsgi-plugin-python3`
* `virtualenv`
* Python/Django dependencies: see `requires/requirements.txt`
* External resources:
* LDAP database
* WooCommerce instance
* [REST API enabled](https://docs.woocommerce.com/document/woocommerce-rest-api/)
* [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/)
* [JWT Authentication for WP REST API](https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/)
(pending)
* SSH access to an OpenVPN server with `create_new_ovpn_config`
* Typically, the Nginx user (`www-data`) will need SSH access
* Test with `sudo -u www-data ssh -p PORT REMOTE_USER@HOSTNAME`
* The user needing access can be changed in
`purist_middleware_monitor.conf`
Other versions and alternatives may work but are untested. See [SETUP.md](SETUP.md) for prerequisites and instructions.
Usage Usage
----- -----
* Install by following the instructions [SETUP.md](SETUP.md) to install.
* Start Django site as a system service, or with `./manage.py runserver` * Start Django site as a system service, or with `./manage.py runserver`
* Visit <https://example.com> and follow the login or registration * Visit <https://example.com> and follow the login or registration
links. links.
* If registration is closed, you will have to create LDAP credentials
another way.
* Manage user profile at <https://example.com/accounts/profile/>
Sharing Sharing and contributions
------- -------------------------
Services middleware <br /> Services middleware <br />
<https://plan.puri.st/module/middleware> <br /> <https://plan.puri.st/module/middleware> <br />
...@@ -69,7 +41,9 @@ Copyright 2017 Purism SPC and contributors <br /> ...@@ -69,7 +41,9 @@ Copyright 2017 Purism SPC and contributors <br />
SPDX-License-Identifier: AGPL-3.0+ SPDX-License-Identifier: AGPL-3.0+
Shared under AGPLv3-or-later, see [COPYING.AGPL.md](COPYING.AGPL.md) Shared under AGPLv3-or-later, see [COPYING.AGPL.md](COPYING.AGPL.md)
for details. Contributions under the same terms are welcome. 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.
Contributions and license notices from other sources are listed in Contributions and license notices from other sources are listed in
[COPYING.md](COPYING.md) [COPYING.md](COPYING.md)
Prerequisites
-------------
* Debian 9
* Python 3.5
* Django 1.11 (included in Python packages below)
* Nginx
* RabbitMQ server
* Must be accessible at `amqp://guest:guest@localhost:5672//`
* This can be achieved with just `apt install rabbitmq-server`
* Additional dependencies (Debian package names):
* `libsasl2-dev`
* `libldap2-dev`
* `libssl-dev`
* `python3-dev`
* `supervisor`
* `uwsgi`
* `uwsgi-emperor`
* `uwsgi-plugin-python3`
* `virtualenv`
* Python/Django dependencies: see `requires/requirements.txt`
* External resources:
* LDAP database
* WooCommerce instance
* [REST API enabled](https://docs.woocommerce.com/document/woocommerce-rest-api/)
* [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/)
* [JWT Authentication for WP REST API](https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/)
(pending)
* OpenVPN instance (SSH access)
* Including [openvpn-confgen](https://plan.puri.st/module/openvpn_confgen)
* Typically, the Nginx user (`www-data`) will need SSH access
* Test with `sudo -u www-data ssh -p PORT REMOTE_USER@HOSTNAME`
* The user needing access can be changed in
`purist_middleware_monitor.conf`
Other versions and alternatives may work but are untested.
Setup Setup
----- -----
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment