Add README and COPYING for django/mit/

[Scripts/git/.git] / django / mit / README

diff --git a/django/mit/README b/django/mit/README
new file mode 100644 (file)
index 0000000..8271dac
--- /dev/null
+++ b/django/mit/README
@@ -0,0 +1,17 @@
+__init__.py contains some useful functionality for Django applications running
+at MIT, particularly on the scripts.mit.edu platform
+* zephyr(msg, clas, instance, rcpt) sends a zephyr (by shelling out to zwrite).
+  This may be useful for debugging or logging
+* ScriptsRemoteUserMiddleware and ScriptsRemoteUserBackend work together to
+  auto-create users from certificates on scripts.mit.edu-hosted sites. Account
+  details are automatically retrieved from LDAP.
+* scripts_login is a view that tries to log users into a site using certs.
+
+To use them, you'll probably want to symlink or copy this directory ("mit")
+into your project, add it to your apps list, and modify your middlewares and
+auth backend appropriately. Do *not* link the django directory into your app;
+it's reasonably likely to break your "import django.foo" statements.
+
+This code is descended from work on Remit (https://remit.scripts.mit.edu/trac/)
+and the ASA DB (https://asa.scripts.mit.edu/trac/); current and past bugs are
+likely to be filed there.