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