admin/params/auth.html.tmpl

[%# The contents of this file are subject to the Mozilla Public
  # License Version 1.1 (the "License"); you may not use this file
  # except in compliance with the License. You may obtain a copy of
  # the License at http://www.mozilla.org/MPL/
  #
  # Software distributed under the License is distributed on an "AS
  # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  # implied. See the License for the specific language governing
  # rights and limitations under the License.
  #
  # The Original Code is the Bugzilla Bug Tracking System.
  #
  # The Initial Developer of the Original Code is Netscape Communications
  # Corporation. Portions created by Netscape are
  # Copyright (C) 1998 Netscape Communications Corporation. All
  # Rights Reserved.
  #
  # Contributor(s): Dave Miller <justdave@bugzilla.org>
  #                 Frédéric Buclin <LpSolit@gmail.com>
  #                 Marc Schumann <wurblzap@gmail.com>
  #%]
[%
   title = "User Authentication"
   desc = "Set up your authentication policies"
%]

[% param_descs = {
  auth_env_id => "Environment variable used by external authentication system " _
                 "to store a unique identifier for each user. Leave it blank " _
                 "if there isn't one or if this method of authentication " _
                 "is not being used.",

  auth_env_email => "Environment variable used by external authentication system " _
                    "to store each user's email address. This is a required " _
                    "field for environmental authentication. Leave it blank " _
                    "if you are not going to use this feature.",

  auth_env_realname => "Environment variable used by external authentication system " _
                       "to store the user's real name. Leave it blank if there " _
                       "isn't one or if this method of authentication is not being " _
                       "used.",

  user_info_class => "Mechanism(s) to be used for gathering a user's login information.
                      More than one may be selected. If the first one returns nothing,
                      the second is tried, and so on.<br>
                      The types are:
                      <dl>
                        <dt>CGI</dt>
                        <dd>
                          Asks for username and password via CGI form interface.
                        </dd>
                        <dt>Env</dt>
                        <dd>
                          Info for a pre-authenticated user is passed in system
                          environment variables.
                        </dd>
                      </dl>",

  user_verify_class => "Mechanism(s) to be used for verifying (authenticating) information
                        gathered by user_info_class.
                        More than one may be selected. If the first one cannot find the
                        user, the second is tried, and so on.<br>
                        The types are:
                        <dl>
                          <dt>DB</dt>
                          <dd>
                            ${terms.Bugzilla}'s built-in authentication. This is the most common
                            choice.
                          </dd>
                          <dt>RADIUS</dt>
                          <dd>
                            RADIUS authentication using a RADIUS server.
                            This method is experimental; please see the
                            $terms.Bugzilla documentation for more information.
                            Using this method requires
                            <a href=\"?section=radius\">additional
                            parameters</a> to be set.
                          </dd>
                          <dt>LDAP</dt>
                          <dd>
                            LDAP authentication using an LDAP server.
                            Please see the $terms.Bugzilla documentation
                            for more information. Using this method requires
                            <a href=\"?section=ldap\">additional
                            parameters</a> to be set.
                          </dd>
                        </dl>",

  rememberlogin => "Controls management of session cookies
                    <ul>
                      <li>
                        on - Session cookies never expire (the user has to login only
                        once per browser).
                      </li>
                      <li>
                        off - Session cookies last until the users session ends (the user
                        will have to login in each new browser session).
                      </li>
                      <li>
                        defaulton/defaultoff - Default behavior as described
                        above, but user can choose whether $terms.Bugzilla will remember his
                        login or not.
                      </li>
                    </ul>",

  requirelogin => "If this option is set, all access to the system beyond the " _
                  "front page will require a login. No anonymous users will " _
                  "be permitted.",

  emailregexp => "This defines the regexp to use for legal email addresses. The " _
                 "default tries to match fully qualified email addresses. Another " _
                 "popular value to put here is <tt>^[^@]+$</tt>, which means " _
                 "'local usernames, no @ allowed.'",

  emailregexpdesc => "This describes in English words what kinds of legal addresses " _
                     "are allowed by the <tt>emailregexp</tt> param.",

  emailsuffix => "This is a string to append to any email addresses when actually " _
                 "sending mail to that address. It is useful if you have changed " _
                 "the <tt>emailregexp</tt> param to only allow local usernames, " _
                 "but you want the mail to be delivered to username@my.local.hostname.",

  createemailregexp => "This defines the regexp to use for email addresses that are " _
                       "permitted to self-register using a 'New Account' feature. The " _
                       "default (.*) permits any account matching the emailregexp " _
                       "to be created. If this parameter is left blank, no users " _
                       "will be permitted to create their own accounts and all accounts " _
                       "will have to be created by an administrator." }
%]
1	[%# The contents of this file are subject to the Mozilla Public
2	# License Version 1.1 (the "License"); you may not use this file
3	# except in compliance with the License. You may obtain a copy of
4	# the License at http://www.mozilla.org/MPL/
5	#
6	# Software distributed under the License is distributed on an "AS
7	# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
8	# implied. See the License for the specific language governing
9	# rights and limitations under the License.
10	#
11	# The Original Code is the Bugzilla Bug Tracking System.
12	#
13	# The Initial Developer of the Original Code is Netscape Communications
14	# Corporation. Portions created by Netscape are
15	# Copyright (C) 1998 Netscape Communications Corporation. All
16	# Rights Reserved.
17	#
18	# Contributor(s): Dave Miller <justdave@bugzilla.org>
19	# Frédéric Buclin <LpSolit@gmail.com>
20	# Marc Schumann <wurblzap@gmail.com>
21	#%]
22	[%
23	title = "User Authentication"
24	desc = "Set up your authentication policies"
25	%]
26
27	[% param_descs = {
28	auth_env_id => "Environment variable used by external authentication system " _
29	"to store a unique identifier for each user. Leave it blank " _
30	"if there isn't one or if this method of authentication " _
31	"is not being used.",
32
33	auth_env_email => "Environment variable used by external authentication system " _
34	"to store each user's email address. This is a required " _
35	"field for environmental authentication. Leave it blank " _
36	"if you are not going to use this feature.",
37
38	auth_env_realname => "Environment variable used by external authentication system " _
39	"to store the user's real name. Leave it blank if there " _
40	"isn't one or if this method of authentication is not being " _
41	"used.",
42
43	user_info_class => "Mechanism(s) to be used for gathering a user's login information.
44	More than one may be selected. If the first one returns nothing,
45	the second is tried, and so on.<br>
46	The types are:
47	<dl>
48	<dt>CGI</dt>
49	<dd>
50	Asks for username and password via CGI form interface.
51	</dd>
52	<dt>Env</dt>
53	<dd>
54	Info for a pre-authenticated user is passed in system
55	environment variables.
56	</dd>
57	</dl>",
58
59	user_verify_class => "Mechanism(s) to be used for verifying (authenticating) information
60	gathered by user_info_class.
61	More than one may be selected. If the first one cannot find the
62	user, the second is tried, and so on.<br>
63	The types are:
64	<dl>
65	<dt>DB</dt>
66	<dd>
67	${terms.Bugzilla}'s built-in authentication. This is the most common
68	choice.
69	</dd>
70	<dt>RADIUS</dt>
71	<dd>
72	RADIUS authentication using a RADIUS server.
73	This method is experimental; please see the
74	$terms.Bugzilla documentation for more information.
75	Using this method requires
76	<a href=\"?section=radius\">additional
77	parameters</a> to be set.
78	</dd>
79	<dt>LDAP</dt>
80	<dd>
81	LDAP authentication using an LDAP server.
82	Please see the $terms.Bugzilla documentation
83	for more information. Using this method requires
84	<a href=\"?section=ldap\">additional
85	parameters</a> to be set.
86	</dd>
87	</dl>",
88
89	rememberlogin => "Controls management of session cookies
90	<ul>
91	<li>
92	on - Session cookies never expire (the user has to login only
93	once per browser).
94	</li>
95	<li>
96	off - Session cookies last until the users session ends (the user
97	will have to login in each new browser session).
98	</li>
99	<li>
100	defaulton/defaultoff - Default behavior as described
101	above, but user can choose whether $terms.Bugzilla will remember his
102	login or not.
103	</li>
104	</ul>",
105
106	requirelogin => "If this option is set, all access to the system beyond the " _
107	"front page will require a login. No anonymous users will " _
108	"be permitted.",
109
110	emailregexp => "This defines the regexp to use for legal email addresses. The " _
111	"default tries to match fully qualified email addresses. Another " _
112	"popular value to put here is <tt>^[^@]+$</tt>, which means " _
113	"'local usernames, no @ allowed.'",
114
115	emailregexpdesc => "This describes in English words what kinds of legal addresses " _
116	"are allowed by the <tt>emailregexp</tt> param.",
117
118	emailsuffix => "This is a string to append to any email addresses when actually " _
119	"sending mail to that address. It is useful if you have changed " _
120	"the <tt>emailregexp</tt> param to only allow local usernames, " _
121	"but you want the mail to be delivered to username@my.local.hostname.",
122
123	createemailregexp => "This defines the regexp to use for email addresses that are " _
124	"permitted to self-register using a 'New Account' feature. The " _
125	"default (.*) permits any account matching the emailregexp " _
126	"to be created. If this parameter is left blank, no users " _
127	"will be permitted to create their own accounts and all accounts " _
128	"will have to be created by an administrator." }
129	%]