From 72914fa665cabe6e12b79b4c758dfcd83d0806aa 2023-09-20 02:28:43
From: Ben Sturmfels <ben@sturm.com.au>
Date: 2023-09-20 02:28:43
Subject: [PATCH] Document the CDN setup for hosting videos

---

diff --git a/README.md b/README.md
index 809274f720cad79ede411cb77ad678961d7f6be0..000105648b36f6a884d7ede91efa91caab387b36 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,12 @@
-Software Freedom Conservancy website
-====================================
+# Software Freedom Conservancy website
 
-
-Contributing
-------------
+## Contributing
 
 The canonical location for this repository is [on Conservancy’s
-Kallithea instance](https://k.sfconservancy.org/website).  Copies of
-this repository elsewhere, such as Github, are for backup purposes
-only..
+Kallithea instance](https://k.sfconservancy.org/website).
 
 
-# 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
@@ -22,20 +17,28 @@ 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 standard Debian installation. For
 configuration requirements, see `deploy/ansible/install.yml`.
 
 
-# Django setup
+## 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.
+
+
+## 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.
 
@@ -44,7 +47,7 @@ Python dependencies are tied to the versions available in Debian.
     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`