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