Add favicon and ability for admins to use their own by setting $head_tag_extra in...
[squirrelmail.git] / config / config_local.example.php
index 84a8bf5ab21767c6fe3c4a180cb295e0d7da1cc4..38c0f26d6d1c6f644d809cbdcc8d8d4d9d9610ec 100644 (file)
@@ -7,7 +7,7 @@
  * Don't do it unless you know what you're doing.
  * Use standard PHP syntax, see config.php for examples.
  *
- * @copyright 2002-2016 The SquirrelMail Project Team
+ * @copyright 2002-2018 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  * the appropriate quote character for the database type
  * being used (backtick for MySQL (and thus MariaDB),
  * double quotes for all others).
+ *
+ * $use_expiring_security_tokens (boolean) allows you to
+ * make SquirrelMail use short-lived anti-CSRF security
+ * tokens that expire as desired (not recommended, can
+ * cause user-facing issues when tokens expire unexpectedly).
+ *
+ * $max_token_age_days (integer) allows you to indicate how
+ * long a token should be valid for (in days) (only relevant
+ * when $use_expiring_security_tokens is enabled).
+ *
+ * $do_not_use_single_token (boolean) allows you to force
+ * SquirrelMail to generate a new token every time one is
+ * requested (which may increase obscurity through token
+ * randomness at the cost of some performance).  Otherwise,
+ * only one token will be generated per user which will
+ * change only after it expires or is used outside of the
+ * validity period specified when calling
+ * sm_validate_security_token() (only relevant when
+ * $use_expiring_security_tokens is enabled).
+ * 
+ * $head_tag_extra can be used to add custom tags inside
+ * the <head> section of *ALL* pages.  The string
+ * "###SM BASEURI###" will be replaced with the base URI
+ * for this SquirrelMail installation.  This may be used,
+ * for example, to add custom favicon tags.  If this
+ * setting is empty here, SquirrelMail will add a favicon
+ * tag by default.  If you want to retain the default favicon
+ * while using this setting, you must include the following
+ * as part of this setting:
+ * $head_tag_extra = '<link rel="shortcut icon" href="###SM BASEURI###favicon.ico">...<YOUR CONTENT HERE>...';
  */
-