From 5a172e453b8b7f4758bd2173713c676442d119b2 Mon Sep 17 00:00:00 2001
From: Ruslan Yakushev <ruslany@php.net>
Date: Wed, 18 Nov 2009 07:27:06 +0000
Subject: [PATCH] Updated the defaults for the INI settings of wincache. Added
 a section about using wincache.php statistics page.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@290900 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/wincache/ini.xml   | 12 ++++---
 reference/wincache/setup.xml | 63 ++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 5 deletions(-)

diff --git a/reference/wincache/ini.xml b/reference/wincache/ini.xml
index d548251594..59a919b4b7 100644
--- a/reference/wincache/ini.xml
+++ b/reference/wincache/ini.xml
@@ -41,8 +41,8 @@
      <row>
       <entry><link linkend="ini.wincache.fcachesize">wincache.fcachesize</link></entry>
       <entry>"24"</entry>
-      <entry>"8"</entry>
-      <entry>"128"</entry>      
+      <entry>"5"</entry>
+      <entry>"85"</entry>      
       <entry>PHP_INI_SYSTEM</entry>
       <entry>Available since WinCache 1.0.0</entry>
      </row>
@@ -73,8 +73,8 @@
      <row>
       <entry><link linkend="ini.wincache.ocachesize">wincache.ocachesize</link></entry>
       <entry>"96"</entry>
-      <entry>"16"</entry>
-      <entry>"256"</entry>      
+      <entry>"15"</entry>
+      <entry>"255"</entry>      
       <entry>PHP_INI_SYSTEM</entry>
       <entry>Available since WinCache 1.0.0</entry>
      </row>
@@ -223,7 +223,9 @@
      <simpara>
       Defines the maximum memory size (in megabytes) that is allocated for the 
       opcode cache. If the cached opcode size exceeds the specified value, 
-      then most stale opcode will be removed from the cache.
+      then most stale opcode will be removed from the cache. Note that the opcode 
+      cache size must be at least 3 times bigger than file cache size. 
+      If that is not the case the opcode cache size will be automatically increased.
      </simpara>
     </listitem>
    </varlistentry>
diff --git a/reference/wincache/setup.xml b/reference/wincache/setup.xml
index 7f62ca43ca..da567fd633 100644
--- a/reference/wincache/setup.xml
+++ b/reference/wincache/setup.xml
@@ -120,6 +120,69 @@
  </section>
  &reference.wincache.ini;
  
+ <section xml:id="wincache.stats">
+  <title>WinCache Statistics Script</title>
+  <para>
+   The installation package for WinCache includes a PHP script, 
+   <filename>wincache.php</filename>, that can be used to obtain cache information 
+   and statistics.
+  </para>
+  <para>
+   If the WinCache extension was installed via the Microsoft Web Platform Installer, 
+   then this script is located in 
+   <filename>%SystemDrive%\Program Files\IIS\Windows Cache for PHP\</filename>. 
+   On a 64-bit version of the Windows Server operating system, the script is located in 
+   <filename>%SystemDrive%\Program Files (x86)\IIS\Windows Cache for PHP</filename>. 
+   If the extension was installed manually, then the <filename>wincache.php</filename> 
+   will be located in the same folder from which the content of the installation package was extracted.
+  </para>
+  <para>
+   To use <filename>wincache.php</filename>, copy it into a root folder of your Web site or 
+   into any subfolder. To protect the script, open it in any text editor and follow the instructions
+   in the comments:
+   <example>
+    <title>Authentication configuration for <filename>wincache.php</filename></title>
+    <programlisting role="php">
+<![CDATA[
+/**
+ * ======================== CONFIGURATION SETTINGS ==============================
+ * If you do not want to use authentication for this page, set USE_AUTHENTICATION to 0.
+ * If you use authentication then replace the default password.
+ */
+define('USE_AUTHENTICATION', 1);
+define('USERNAME', 'wincache');
+define('PASSWORD', 'wincache');
+
+/**
+ * The Basic PHP authentication will work only when IIS is configured to support 
+ * Anonymous Authentication' and nothing else. If IIS is configured to support/use
+ * any other kind of authentication like Basic/Negotiate/Digest etc, this will not work.
+ * In that case use the array below to define the names of users in your 
+ * domain/network/workgroup which you want to grant access to.
+ */
+$user_allowed = array('DOMAIN\user1', 'DOMAIN\user2', 'DOMAIN\user3');
+
+/**
+ * If the array contains string 'all', then all the users authenticated by IIS
+ * will have access to the page. Uncomment the below line and comment above line
+ * to grant access to all users who gets authenticated by IIS.
+ */
+/* $user_allowed = array('all'); */
+
+/** ===================== END OF CONFIGURATION SETTINGS ========================== */
+]]>
+    </programlisting>
+   </example>
+   <note>
+    <simpara>
+     Always protect the <filename>wincache.php</filename> script by using either 
+     the built-in authentication or the server's authentication mechanism. 
+     Leaving this script unprotected may compromise the security of your 
+     web application and web server.
+    </simpara>
+   </note>
+  </para>
+ </section>
  <section xml:id="wincache.resources">
   &reftitle.resources;
   &no.resource;