summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..75a5c41
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+ShareGuard is a system to facilitate the limited sharing of files.
+
+ShareGuard maintains an authentication and authorization database,
+in which users can be granted access to "stashes". From this
+database it handles web authentication and authorization, directory
+maintenance, and other logic.
+
+Users are global to the database, and can be authorized to any
+number of stashes.
+
+At present, the web frontend (stashbox) is written in Python
+and the other components are written in Haskell.
+
+It is unusual in that users do not need to manipulate .htaccess
+and htpasswd files to control access to the files they wish to
+share over the web.
+
+
+Dependencies
+============
+ConfigFile - LGPL 2.1+ - https://github.com/jgoerzen/configfile/wiki
+cgi - BSD3 - http://andersk.mit.edu/haskell/cgi/
+haskelldb - BSD3 - http://trac.haskell.org/haskelldb
+xhtml - BSD3 - http://hackage.haskell.org/package/xhtml
+web.py - public domain & BSD - http://webpy.org/