Conservancy/website
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Software Freedom Conservancy's Website
2345 commits 2 branches 0 tags 365 MiB
HTML 72.8%
Python 14.5%
CSS 9.5%
TeX 2.6%
JavaScript 0.5%
Find a file
Ben Sturmfels 3826b6fb66
Switch settings to use "the one true way" approach 
The advantage of this approach is that the production and dev configurations are
in version control, so there's less opportunity for surprises.

As advocated by Jacob Kaplan-Moss (OSCON 2011) and Two Scoops of Django book.
2024-03-20 14:10:00 +11:00
bin Switch from "restart apache2" to "reload apache2" 2024-03-16 09:07:11 +11:00
conservancy Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00
deploy Remove conservancy-www-update timer-based deploy 2024-03-13 14:50:48 +11:00
.dockerignore Add .dockerignore to ignore everything except requirements.txt 2023-10-26 12:44:23 +11:00
.gitignore Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00
AGPLv3 License texts 2010-09-26 18:53:20 -04:00
CC-By-SA-3.0 Added CC-By-SA-3.0 license 2010-10-03 21:59:53 -04:00
Dockerfile-debian-bookworm Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00
ISC_LICENSE License texts 2010-09-26 18:53:20 -04:00
manage.py Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00
README.md Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00
requirements.txt Upgrade to Django 4.2 LTS 2024-03-19 22:14:20 +11:00
TODO.md Switch settings to use "the one true way" approach 2024-03-20 14:10:00 +11:00

README.md

Software Freedom Conservancy website

Contributing

The canonical location for this repository is on Conservancy’s Kallithea instance.

License

The software included herein, such as the Python source files, are generally licensed AGPLv3-or-later. The Javascript is a hodgepodge of licensing, but all of it is compatible with 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.

Server configuration

Conservancy's webserver runs on a standard Debian installation. For configuration requirements, see deploy/ansible/install.yml.

CDN

Requests to any URL starting with /videos/ are forwarded to our CDN server to reduce bandwidth use. These files are uploaded to the CDN manually via the Rackspace API. Note that the Apache rewrite rule requires that the file not exist on disk for the redirect to be applied.

Local development

Python dependencies in requirements.txt are tied to the versions available in Debian:

python3 -m pip install -r requirements.txt

To run the tests, install pytest-django and run pytest:

python3 -m pip install pytest-django
python3 -m pytest

Then run:

python3 manage.py migrate
python3 manage.py runserver

There is also a Dockerfile available if that's more convenient. See that file for details.

Deploying

To deploy, run bin/deploy. This requires SSH access to hickory.sfconservancy.org.

Link checking

To check for broken links, log on to hickory.sfconservancy.org and run linkchecker https://sfconservancy.org/.

Note that the Apache configuration has a significant number of aliases and redirects for historic URL changes which means that linkchecker may not run cleanly in local development.