website/README.md

58 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Software Freedom Conservancy website
====================================
Contributing
------------
The canonical location for this repository is [on Conservancys
Kallithea instance](https://k.sfconservancy.org/website). Copies of
this repository elsewhere, such as Github, are for backup purposes
only..
License
-------
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).
Server configuration
--------------------
conservancy's webserver runs on a machine called aspen.sfconservancy.org, which
is a standard Debian installation.
The following packages are installed to make Django and Apache work on a
squeeze install:
$ aptitude install python-django apache2 sqlite3 python3-sqlite libapache2-mod-wsgi-py3
Django setup
------------
0. Make sure the Python module 'djangopw', with the global variable
'djangoadmin_password' is somewhere importable in the default
PYTHON_PATH.
Local development
---------
python3 -m pip install -r requirements.txt
cd www
python manage.py runserver
Deploying
---------
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.