Permalink
Browse files

Update README: plugin works in trac 0.12

  • Loading branch information...
1 parent 6739fd2 commit 6a638d84de418d377e082dafb95b210b20480d1f @dairiki dairiki committed Mar 6, 2012
Showing with 46 additions and 31 deletions.
  1. +46 −31 README.rst
View
77 README.rst
@@ -5,10 +5,8 @@ OpenID Authentication Plugin
Description
===========
-This plugin allows to login to Trac using OpenID. Please, note that
-this plugin works with Trac 0.11 version only. Later versions might
-work as well but I personally will not support them since I don't use
-Trac anymore myself.
+This plugin allows to login to Trac using OpenID. I use it with Trac 0.12.
+It was developed under Trac 0.11, so it should work there too.
Download & Source
=================
@@ -85,58 +83,75 @@ to illustrate them.
check_auth_ip = true
check_auth_ip_mask = 255.255.255.0
# number of seconds until cookie will expire
- expires = 86400
+ auth_cookie_lifetime = 86400
[openid]
- # In some cases company might have internal OpenID server that automatically
- # identifies user (e.g. windows SSPI). Also known as single sign-on.
- # default_openid = http://openid.ee
- # Require sreg data
+
+ # In some cases company might have internal OpenID server that
+ # automatically identifies user (e.g. windows SSPI). Also known as
+ # single sign-on. default_openid = http://openid.ee Require sreg
+ # data
sreg_required = false
- # If you want username to be written as username_in_remote_system<openid_url> use:
- # combined_username = false
+
+ # If you want username to be written as
+ # "username_in_remote_system <openid_url>" use:
+ #combined_username = true
+
# Default PAPE method to request from OpenID provider.
# pape_method =
+
# What is OpenID link.
whatis = http://openid.net/what/
# Sign-up link
signup = http://openid.net/get
# Gmail login button (default: true)
# gmail = false
- # In some cases you might want allow users to login to different projects using
- # different OpenIDs. In that case don't use absolute trust root.
+ # In some cases you might want allow users to login to different
+ # projects using different OpenIDs. In that case don't use
+ # absolute trust root.
absolute_trust_root = false
- # Remove http:// or https:// from URL that is used as username. (Default: false)
+ # Remove http:// or https:// from URL that is used as
+ # username. (Default: false)
strip_protocol = false
# Remove trailing slash from URL that is user as username (Defaul: false)
strip_trailing_slash = false
- # Expiration time acts as timeout. E.g. if expiration time is 24 hour and
- # you login again in those 24 times. Expiration time is extended for another
- # 24 hours. (Default: false)
+ # Expiration time acts as timeout. E.g. if expiration time is 24
+ # hour and you login again in those 24 hours. Expiration time is
+ # extended for another 24 hours. (Default: false)
timeout = false
- # white and black lists.
- # E.g.: Allows all the people from Lithuania, Latvia or Estonia except delfi domain.
- # IMPORTANT: strip_protocol and strip_trailing_slash affects what openid will be given to white_list or black_list
+ # White and black lists.
+ # E.g.: Allows all the people from Lithuania, Latvia or Estonia
+ # except delfi domain.
+ # IMPORTANT: strip_protocol and strip_trailing_slash affects what
+ # openid will be given to white_list or black_list
#white_list = *.lt, *.lv, *.ee
#black_list = *.delfi.lt,*.delfi.lv,*.delfi.ee
- # In addition to white and black lists you can use external service
- # for allowing users into trac. To control that you must use check_list
- # and check_list_key option. It will generate URL:
- # check_list?check_list_key=openid&email=email
+ # In addition to white and black lists you can use external
+ # service for allowing users into trac. To control that you must
+ # use check_list and check_list_key option. It will generate URL:
+ #
+ # check_list?check_list_key=openid&email=email
+ #
# email will be attached only if available.
+ #
# It expects JSON result in following format:
- # {"check_list_key": true}
- # IMPORTANT: this functionality uses simplejson which might not be available on your system by default.
- # Install it if you want to use this functionality.
- # IMPORTANT: strip_protocol and strip_trailing_slash affects what openid will be send to service
- # NOTE: You can specify check_list_username as well. In that case JSON service should return new
- # username as well. E.g. check_list_username=username. Expected result from JSON service is:
- # {"check_list_key": true, "username": "Peter"}
+ #
+ # {"check_list_key": true}
+ #
+ # IMPORTANT: strip_protocol and strip_trailing_slash affects what
+ # openid will be send to service
+ # NOTE: You can specify check_list_username as well. In that case
+ # JSON service should return new username as
+ # well. E.g. check_list_username=username. Expected result from
+ # JSON service is:
+ #
+ # {"check_list_key": true, "username": "Peter"}
+ #
# You can use this option to map your OpenIDs to internal username.
#check_list = http://your.site.com/openidallow
#check_list_key = check_list

0 comments on commit 6a638d8

Please sign in to comment.