2023-09-07 12:59:23 +00:00
|
|
|
|
Software Freedom Conservancy website
|
|
|
|
|
====================================
|
|
|
|
|
|
|
|
|
|
|
2014-12-05 15:18:17 +00:00
|
|
|
|
Contributing
|
2023-09-07 12:59:23 +00:00
|
|
|
|
------------
|
2014-12-05 15:18:17 +00:00
|
|
|
|
|
2015-12-22 00:57:01 +00:00
|
|
|
|
The canonical location for this repository is [on Conservancy’s
|
2023-09-07 12:59:23 +00:00
|
|
|
|
Kallithea instance](https://k.sfconservancy.org/website). Copies of
|
2015-12-22 00:57:01 +00:00
|
|
|
|
this repository elsewhere, such as Github, are for backup purposes
|
|
|
|
|
only..
|
2014-12-05 15:18:17 +00:00
|
|
|
|
|
2023-09-07 12:59:23 +00:00
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
# License
|
2014-12-05 15:21:01 +00:00
|
|
|
|
|
|
|
|
|
The software included herein, such as the Python source files, are generally
|
|
|
|
|
licensed [AGPLv3](AGPLv3)-or-later. The Javascript is a hodgepodge of
|
|
|
|
|
licensing, but all of it is compatible with [AGPLv3](AGPLv3)-or-later. See
|
|
|
|
|
the notices at the top of each Javascript file for licensing details.
|
|
|
|
|
|
|
|
|
|
The content and text (such as the HTML files) is currently
|
|
|
|
|
[CC-BY-SA-3.0](CC-By-SA-3.0).
|
2014-12-05 15:18:17 +00:00
|
|
|
|
|
2010-09-26 22:00:53 +00:00
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
# Server configuration
|
2023-09-07 12:59:23 +00:00
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
Conservancy's webserver runs on a standard Debian installation. For
|
|
|
|
|
configuration requirements, see `deploy/ansible/install.yml`.
|
2010-09-26 22:00:53 +00:00
|
|
|
|
|
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
# Django setup
|
2010-09-26 23:24:22 +00:00
|
|
|
|
|
|
|
|
|
0. Make sure the Python module 'djangopw', with the global variable
|
|
|
|
|
'djangoadmin_password' is somewhere importable in the default
|
|
|
|
|
PYTHON_PATH.
|
2023-09-07 12:59:23 +00:00
|
|
|
|
|
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
# Local development
|
|
|
|
|
|
|
|
|
|
Python dependencies are tied to the versions available in Debian.
|
2023-09-07 12:59:23 +00:00
|
|
|
|
|
|
|
|
|
python3 -m pip install -r requirements.txt
|
|
|
|
|
cd www
|
|
|
|
|
python manage.py runserver
|
|
|
|
|
|
2023-09-14 08:14:22 +00:00
|
|
|
|
|
|
|
|
|
# Deploying
|
2023-09-07 12:59:23 +00:00
|
|
|
|
|
|
|
|
|
Changes pushed to the https://k.sfconservancy.org/website repository are
|
|
|
|
|
automatically deployed to the production website by the `conservancy-www-update`
|
|
|
|
|
SystemD timer. See `systemd/conservancy-www-update.timer` for details.
|