diff --git a/README.md b/README.md index 85a1b581dcdd9cfef9fe70acb28ebd40d6bb4f9b..809274f720cad79ede411cb77ad678961d7f6be0 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ this repository elsewhere, such as Github, are for backup purposes only.. -License -------- +# License The software included herein, such as the Python source files, are generally licensed [AGPLv3](AGPLv3)-or-later. The Javascript is a hodgepodge of @@ -23,35 +22,29 @@ The content and text (such as the HTML files) is currently [CC-BY-SA-3.0](CC-By-SA-3.0). -Server configuration --------------------- +# Server configuration -conservancy's webserver runs on a machine called aspen.sfconservancy.org, which -is a standard Debian installation. +Conservancy's webserver runs on a standard Debian installation. For +configuration requirements, see `deploy/ansible/install.yml`. -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 ------------- +# 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 ---------- +# Local development + +Python dependencies are tied to the versions available in Debian. python3 -m pip install -r requirements.txt cd www python manage.py runserver -Deploying ---------- + +# Deploying Changes pushed to the https://k.sfconservancy.org/website repository are automatically deployed to the production website by the `conservancy-www-update`