aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2013-06-11 17:18:49 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2013-06-12 14:19:03 +0300
commit2f5805da925c62239c78ec79b84baa1434a4ad04 (patch)
treec1171025fd2106913105d3dc601edc914f139c8b /README.md
parent8bb37d2eab81089923990d736e016577780b283e (diff)
Fix line-endings (CRLF -> LF).
Diffstat (limited to 'README.md')
-rw-r--r--README.md152
1 files changed, 76 insertions, 76 deletions
diff --git a/README.md b/README.md
index a263a16..a38d6b1 100644
--- a/README.md
+++ b/README.md
@@ -1,77 +1,77 @@
-Django authentification backend using Crowd REST API
-====================================================
-
-This is a very rough implementation of a django backend
-using Crowd's REST API.
-
-It is inspired by the various forks of django-crowd-backend.
-Those implementations were always using SOUP.
-This one is just using REST API supported by Crowd.
-See [Atlassian](https://developer.atlassian.com/display/CROWDDEV/Crowd+REST+APIs).
-
-Current implementation
-======================
-
-- Connect to Crowd server
-- Authenticate given user by password
-- Sync Django user instance with attributes from Crowd user
-- Setup Djnago user staff/superuser flags based on associated Crowd groups of user
-
-Features
-========
-
-- HTTPS certificate validation when connecting to secure Crowd url
-
-Missing
-=======
-
-- No handling of SSO cookie
-
-Dependencies
-============
-
-- just 'urllib2' with a little tweak from [VerifiedHTTPS](https://github.com/josephturnerjr/urllib2.VerifiedHTTPS)
- to allow validation of https certificate.
-
-How to use it
-=============
-
-- Edit settings.py to add 'crowdrest' app to your list of apps
-
-- Adapt configuration settings for crowdrest in settings.py by adding
-
- _whether you want to sync django users from Crowd attributes_
-
- AUTH_CROWD_ALWAYS_UPDATE_USER = True
-
- _Django user will get staff flag when Crowd user is in given Crowd group_
-
- AUTH_CROWD_STAFF_GROUP = 'staff'
-
- _Django user will get superuser flag when Crowd user is in given Crowd group_
-
- AUTH_CROWD_SUPERUSER_GROUP = 'superuser'
-
- _crowdrest will use this username and password to connect to Crowd server_
-
- AUTH_CROWD_APPLICATION_USER = 'django'
-
- AUTH_CROWD_APPLICATION_PASSWORD = 'django'
-
- _URL to Crowd REST API_
-
- AUTH_CROWD_SERVER_REST_URI = 'http://127.0.0.1:8095/crowd/rest/usermanagement/latest'
-
- _Use given certificate file to validate https connection to Crowd server_
-
- AUTH_CROWD_SERVER_TRUSTED_ROOT_CERTS_FILE = None
-
-Problems ?
-==========
-
-Just send me a message. Let's see if I can help.
-
-License
-=======
-
+Django authentification backend using Crowd REST API
+====================================================
+
+This is a very rough implementation of a django backend
+using Crowd's REST API.
+
+It is inspired by the various forks of django-crowd-backend.
+Those implementations were always using SOUP.
+This one is just using REST API supported by Crowd.
+See [Atlassian](https://developer.atlassian.com/display/CROWDDEV/Crowd+REST+APIs).
+
+Current implementation
+======================
+
+- Connect to Crowd server
+- Authenticate given user by password
+- Sync Django user instance with attributes from Crowd user
+- Setup Djnago user staff/superuser flags based on associated Crowd groups of user
+
+Features
+========
+
+- HTTPS certificate validation when connecting to secure Crowd url
+
+Missing
+=======
+
+- No handling of SSO cookie
+
+Dependencies
+============
+
+- just 'urllib2' with a little tweak from [VerifiedHTTPS](https://github.com/josephturnerjr/urllib2.VerifiedHTTPS)
+ to allow validation of https certificate.
+
+How to use it
+=============
+
+- Edit settings.py to add 'crowdrest' app to your list of apps
+
+- Adapt configuration settings for crowdrest in settings.py by adding
+
+ _whether you want to sync django users from Crowd attributes_
+
+ AUTH_CROWD_ALWAYS_UPDATE_USER = True
+
+ _Django user will get staff flag when Crowd user is in given Crowd group_
+
+ AUTH_CROWD_STAFF_GROUP = 'staff'
+
+ _Django user will get superuser flag when Crowd user is in given Crowd group_
+
+ AUTH_CROWD_SUPERUSER_GROUP = 'superuser'
+
+ _crowdrest will use this username and password to connect to Crowd server_
+
+ AUTH_CROWD_APPLICATION_USER = 'django'
+
+ AUTH_CROWD_APPLICATION_PASSWORD = 'django'
+
+ _URL to Crowd REST API_
+
+ AUTH_CROWD_SERVER_REST_URI = 'http://127.0.0.1:8095/crowd/rest/usermanagement/latest'
+
+ _Use given certificate file to validate https connection to Crowd server_
+
+ AUTH_CROWD_SERVER_TRUSTED_ROOT_CERTS_FILE = None
+
+Problems ?
+==========
+
+Just send me a message. Let's see if I can help.
+
+License
+=======
+
Use this code as you want. Consider it free. Say thank you. Don't blame me if it doesn't work for you. \ No newline at end of file