diff --git a/README.md b/README.md index 6c5f56276a60e6474ff1320015f473cab838fe6c..85a1b581dcdd9cfef9fe70acb28ebd40d6bb4f9b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ +Software Freedom Conservancy website +==================================== + + Contributing -============ +------------ The canonical location for this repository is [on Conservancy’s -Kallithea instance](http://k.sfconservancy.org/website). Copies of +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 @@ -17,22 +22,37 @@ 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 -dogwood.sfconservancy.org, which is a standard Debian installation. +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 python2.5-sqlite libapache2-mod-python - + $ aptitude install python-django apache2 sqlite3 python3-sqlite libapache2-mod-wsgi-py3 -Django Setup -============ +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.