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