Add documentation for bind user in sample authentication.yml
[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     # End LDAP configuration example
61     ############################################################################
62
63     ############################################################################
64     # Example of configuring Atlassian Crowd authentication
65     #- adapter: Gitorious::Authentication::CrowdAuthentication
66
67       # IP/hostname to Crowd server
68       #host: crowd.example
69
70       # Override default port (8095)
71       #port: 80
72
73       # Set context path for Crowd installation
74       #context: /crowd
75
76       # The application name
77       #application: gitorious
78
79       # Application password
80       #password: 123456789
81
82     # End Crowd configuration example
83     ############################################################################
84     
85     ############################################################################
86     # Example of configuring Kerberos authentication
87     #- adapter: Gitorious::Authentication::KerberosAuthentication
88     
89       # Set the Kerberos realm (should be uppercase)
90       #realm: EXAMPLE.COM
91       
92       # The default email domain for users in this realm. If you do not
93       # specify any email_domain, the default is to use the lowercase
94       # realm value.
95       #email_domain: example.com
96       
97       # Note that you must also set up Apache's mod_auth_kerb within
98       # httpd.conf. For example:
99       #  # Enable SSO authentication via Kerberos
100       #  <Location /sessions/http>
101       #    AuthType Kerberos
102       #    AuthName "Gitorious Web UI"
103       #    KrbMethodNegotiate on
104       #    KrbMethodK5Passwd off
105       #    KrbServiceName HTTP
106       #    KrbAuthRealm EXAMPLE.COM
107       #    Krb5Keytab /etc/httpd/http.keytab
108       #    Require valid-user
109       #    ErrorDocument 401 /401.html
110       #  </Location>
111     
112     # End Kerberos configuration example
113     ############################################################################
114
115     ############################################################################
116     # Example of configuring SSL client certificate authentication
117     #- adapter: Gitorious::Authentication::SSLAuthentication
118       # What certificate field to use as login name. Default is CN.
119       #login_field: Email
120
121       # Whether the domain should be stripped, if the email address is
122       # used as login name. Default is false.
123       #login_strip_domain: true
124
125       # Character used to replace forbidden characters in login names.
126       # Set to '' to strip forbidden characters. Default is '-'.
127       #login_replace_char: ''
128
129       # Note that you must also set up Apache to create SSL related
130       # environment variables for the http auth controller:
131       #  <Location /sessions/http>
132       #    SSLOptions +StdEnvVars
133       #  </Location>
134
135     # End SSL client certificate configuration example
136     ############################################################################
137
138 # production: