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