Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Revised Cookies documentation

- Removed paragraph with incorrect information about need to redefine
  cookie variables after modifying $g_cookie_prefix.
- Revised layout
- Updated description for some variables
- Reflected these changes in related comments in config_default_inc.php
  • Loading branch information...
commit 3f75f68b08b0c52d5b3b488034f99214977a5dab 1 parent 8890b21
Damien Regad dregad authored
22 config_defaults_inc.php
View
@@ -2803,28 +2803,36 @@
*****************************/
/**
- * --- cookie path ---------------
- * set this to something more restrictive if needed
- * http://www.php.net/manual/en/function.setcookie.php
+ * Specifies the path under which a cookie is visible
+ * All scripts in this directory and its sub-directories will be able
+ * to access MantisBT cookies.
+ * It is recommended to set this to the actual MantisBT path.
+ * @link http://php.net/function.setcookie
* @global string $g_cookie_path
*/
$g_cookie_path = '/';
/**
- *
+ * The domain that the MantisBT cookies are available to
* @global string $g_cookie_domain
*/
$g_cookie_domain = '';
/**
- * cookie version for view_all_page
+ * Version of the view_all_page cookie
+ * It is not expected for the user to need to change this setting
+ * @see $g_view_all_cookie
* @global string $g_cookie_version
*/
$g_cookie_version = 'v8';
/**
- * --- cookie prefix ---------------
- * set this to a unique identifier. No spaces or periods.
+ * Prefix for all MantisBT cookies
+ * This should be an identifier which does not include spaces or periods,
+ * and should be unique per MantisBT installation, especially if
+ * $g_cookie_path is not restricting the cookies' scope to the actual
+ * MantisBT directory.
+ * @see $g_cookie_path
* @global string $g_cookie_prefix
*/
$g_cookie_prefix = 'MANTIS';
77 docbook/administration_guide/en/configuration.sgml
View
@@ -2515,51 +2515,78 @@
<section id="admin.config.cookies">
<title>Cookies</title>
- <para>The configuration variables $g_string_cookie,
- $g_project_cookie, $g_view_all_cookie, $g_manage_cookie are
- calculated based on $g_cookie_prefix. When you change the cookie
- prefix in config_inc.php, you need to follow it with a copy of the
- four lines that calculate the names for these cookies.
- </para>
<variablelist>
<varlistentry>
<term>$g_cookie_path</term>
<listitem>
- <para>This is specifies to the path under which a cookie is
- visible. All scripts in this directory and its sub-directories will
- be able to access MantisBT cookies. Default value is '/'. It is
- recommended to set this to the actual MantisBT path.
- </para>
+ <para>Specifies the path under which a cookie is visible.
+ </para>
+ <para>All scripts in this directory and its sub-directories
+ will be able to access MantisBT cookies.
+ </para>
+ <para>Default value is '/'.
+ It is recommended to set this to the actual MantisBT path.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_cookie_domain</term>
<listitem>
- <para>Unused</para>
+ <para>The domain that the MantisBT cookies are available to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_cookie_version</term>
<listitem>
- <para>Cookie version is used as a prefix for cookies that should
- be expire when the code is changed in a certain way. The developers
- would increase this version when necessary, which in effect will
- cause the creation of new cookies that are compatible with the new
- code. It is not expected for the user to need to change this
- setting.
- </para>
+ <para>Version of the view_all_page cookie.</para>
+ <para>This is used as a prefix for cookies that should
+ be expired when the code is changed in a certain way.
+ The developers would increase this version when necessary,
+ which in effect will cause the creation of new cookies
+ that are compatible with the new code.
+ </para>
+ <para>It is not expected for the user to need to change this
+ setting.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term>$g_cookie_prefix</term>
<listitem>
- <para>This should be set to a unique identifier which does not
- include spaces or periods. Again, this should be unique per
- MantisBT installation, especially if $g_cookie_path is not
- restricting the cookies scope to the actual MantisBT
- directory.
- </para>
+ <para>Prefix for all MantisBT cookies</para>
+ <para>This should be an identifier which does not include
+ spaces or periods, and should be unique per MantisBT
+ installation, especially if $g_cookie_path is not
+ restricting the cookies' scope to the actual
+ MantisBT directory.
+ </para>
+ <para>It applies to the cookies listed below. Their actual
+ names are calculated by prepending the prefix, and
+ it is not expected for the user to need to change these.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>$g_string_cookie</para>
+ </listitem>
+ <listitem>
+ <para>$g_project_cookie</para>
+ </listitem>
+ <listitem>
+ <para>$g_view_all_cookie</para>
+ </listitem>
+ <listitem>
+ <para>$g_manage_cookie</para>
+ </listitem>
+ <listitem>
+ <para>$g_logout_cookie</para>
+ </listitem>
+ <listitem>
+ <para>$g_bug_list_cookie</para>
+ </listitem>
+ </itemizedlist>
+
</listitem>
</varlistentry>
</variablelist>
Please sign in to comment.
Something went wrong with that request. Please try again.