Permalink
Browse files

add readme and license

  • Loading branch information...
1 parent 15ae629 commit d98f4af2a5a69aa52575d1ce3f3cf261d25088e4 @mnutt mnutt committed Jan 15, 2012
Showing with 60 additions and 0 deletions.
  1. +22 −0 LICENSE
  2. +38 −0 README.md
View
22 LICENSE
@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Nutt
+
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,38 @@
+DOORMAN
+=======
+
+Doorman is an http proxy that authenticates via OAuth.
+
+Your organization probably has some internal services that need to be
+password-protected. You likely also already manage users using an external
+service. (Github, Google Apps, etc) Wouldn't it be nice if you could
+delegate your internal app's authentication/authorization to that app?
+
+![Screenshot](http://cl.ly/253L0I1S2i190X3m1M1Q/Image%202012.01.15%204:15:52%20AM.png)
+
+Requirements
+------------
+
+ * node.js >= 0.4.x
+
+
+Installation
+------------
+
+ * `npm install`
+ * copy conf.example.js to conf.js and modify
+
+
+Strategies
+----------
+
+Doorman uses [everyauth](https://github.com/bnoguchi/everyauth) for authenticating,
+so it supports a wide variety of providers for authentication. For authorization,
+we need to determine which authenticated users to let in. (see `lib/modules`) So
+far only the Github module is complete, but others are fairly easy.
+
+
+License
+-------
+
+Licensed under the MIT License. See LICENSE.

0 comments on commit d98f4af

Please sign in to comment.