Support looking up (User) members of an LDAP group
[gitorious:mainline.git] / config / authentication.sample.yml
1 # Configure authentication by saving this file as authentication.yml One section
2 # for each RAILS_ENV, like database.yml
3 #
4 # If you just want straight database backed authentication you don't need this
5 # file at all.
6 #
7 development:
8   # Disable database authentication altogether
9   #disable_default: true
10
11   # additional methods, an array of hashes
12   #methods:
13     # An adapter is a class that implements an authentication mechanism. You
14     # can roll your own, or use one of Gitorious' prepackaged ones.
15     # Available implementations are:
16     # Gitorious::Authentication::LDAPAuthentication
17     # Gitorious::Authentication::Crowd
18
19     ############################################################################
20     # Example of configuring LDAP authentication
21     #- adapter: Gitorious::Authentication::LDAPAuthentication
22
23       # IP/hostname to LDAP server
24       #host: ldap.example
25
26       # Override the default port (389)
27       #port: 1999
28
29       # The base DN to search
30       #base_dn: DC=gitorious,DC=org
31
32       # What LDAP attribute to use for user authentication. Default is CN
33       #login_attribute: uid
34
35       # How to build a user's DN. Default: $LOGIN_ATTRIBUTE={},$BASE_DN,
36       # e.g. CN=chris,DC=gitorious,DC=org
37       #distinguished_name_template: "{}@gitorious.org"
38
39       # Map LDAP fields to database fields.
40       # Default: displayname => fullname, mail => email
41       # attribute_mapping:
42         # givenName: fullname
43         # publicEmail: email
44
45       # See Net-LDAP for other options, or use "none" for no encryption.
46       # Defaults to "simple_tls" if not set.
47       #encryption: simple_tls
48
49       # A class/object that will be called after successful authentication
50       # through LDAP. Will be "constantized", post_authenticate will be called
51       # with an options hash. See LdapAuthenticationTest.
52       #callback_class: SampleCallback
53
54       # Specify a username/password to use for authenticated bind
55       # NOTE: This is required when using LDAP for authorization
56       #bind_user:
57       #  username: boss
58       #  password: sikret
59
60       # When using LDAP authorization: which attribute in a user
61       # record specifies groups a user is member of
62       # This will depend on your schema/LDAP server implementation
63       # but in 9/10 cases, it will be memberof
64       #membership_attribute_name: memberof
65
66       # When using LDAP authorization: which attribute in a group
67       # record specifies users that are member of the group
68       # This will depend on your  LDAP schema, but will usually be 
69       # member or uniquemember
70       #members_attribute_name: member
71
72     # End LDAP configuration example
73     ############################################################################
74
75     ############################################################################
76     # Example of configuring Atlassian Crowd authentication
77     #- adapter: Gitorious::Authentication::CrowdAuthentication
78
79       # IP/hostname to Crowd server
80       #host: crowd.example
81
82       # Override default port (8095)
83       #port: 80
84
85       # Set context path for Crowd installation
86       #context: /crowd
87
88       # The application name
89       #application: gitorious
90
91       # Application password
92       #password: 123456789
93
94     # End Crowd configuration example
95     ############################################################################
96     
97     ############################################################################
98     # Example of configuring Kerberos authentication
99     #- adapter: Gitorious::Authentication::KerberosAuthentication
100     
101       # Set the Kerberos realm (should be uppercase)
102       #realm: EXAMPLE.COM
103       
104       # The default email domain for users in this realm. If you do not
105       # specify any email_domain, the default is to use the lowercase
106       # realm value.
107       #email_domain: example.com
108       
109       # Note that you must also set up Apache's mod_auth_kerb within
110       # httpd.conf. For example:
111       #  # Enable SSO authentication via Kerberos
112       #  <Location /sessions/http>
113       #    AuthType Kerberos
114       #    AuthName "Gitorious Web UI"
115       #    KrbMethodNegotiate on
116       #    KrbMethodK5Passwd off
117       #    KrbServiceName HTTP
118       #    KrbAuthRealm EXAMPLE.COM
119       #    Krb5Keytab /etc/httpd/http.keytab
120       #    Require valid-user
121       #    ErrorDocument 401 /401.html
122       #  </Location>
123     
124     # End Kerberos configuration example
125     ############################################################################
126
127     ############################################################################
128     # Example of configuring SSL client certificate authentication
129     #- adapter: Gitorious::Authentication::SSLAuthentication
130       # What certificate field to use as login name. Default is CN.
131       #login_field: Email
132
133       # Whether the domain should be stripped, if the email address is
134       # used as login name. Default is false.
135       #login_strip_domain: true
136
137       # Character used to replace forbidden characters in login names.
138       # Set to '' to strip forbidden characters. Default is '-'.
139       #login_replace_char: ''
140
141       # Note that you must also set up Apache to create SSL related
142       # environment variables for the http auth controller:
143       #  <Location /sessions/http>
144       #    SSLOptions +StdEnvVars
145       #  </Location>
146
147     # End SSL client certificate configuration example
148     ############################################################################
149
150 # production: