adding back example file

git-svn-id: svn://svn.lighttpd.net/xcache/trunk@911 c26eb9a1-5813-0410-bd6c-c2e55f420ca7

admin/config.example.php

@@ -1,14 +1,15 @@
 <?php
 
-// this is default config, DO NOT modify this file
-// copy this file and write your own config and name it as config.php
+// DO NOT modify this file
+// if you want to customize config, copy this file and name it as config.php
+// upgrading your config.php when config.example.php were upgraded
 
-// detected by browser
+// leave this setting unset to auto detect using browser request header
 // $config['lang'] = 'en-us';
 
 $config['charset'] = "UTF-8";
 
-// translators only
+// enable this for translators only
 $config['show_todo_strings'] = false;
 
 // width of graph for free or usage blocks
@@ -20,20 +21,18 @@ $config['percent_graph_type'] = 'used'; // either 'used' or 'free'
 $config['enable_eval'] = false;
 
 // this ob filter is applied for the cache list, not the whole page
-$config['path_nicer'] = 'ob_filter_path_nicer_default';
-
-/*
 function custom_ob_filter_path_nicer($list_html)
 {
 	$list_html = ob_filter_path_nicer_default($list_html); // this function is from common.php
 	return $list_html;
 }
 $config['path_nicer'] = 'custom_ob_filter_path_nicer';
-*/
 
-// you can simply let xcache to do the http auth
-// but if you have your home made login/permission system, you can implement the following
-// {{{ home made login example
+// XCache builtin http auth is enforce for security reason
+// if http auth is disabled, any vhost user that can upload *.php, will see all variable data cached in XCache
+
+// but if you have your own login/permission system, you can use the following example
+// {{{ login example
 // this is an example only, it's won't work for you without your implemention.
 /*
 function check_admin_and_by_pass_xcache_http_auth()
@@ -41,21 +40,24 @@ function check_admin_and_by_pass_xcache_http_auth()
 	require("/path/to/user-login-and-permission-lib.php");
 	session_start();
 
-	if (!user_logined()) {
+	if (user_logined()) {
+		user_load_permissions();
+		if (user_is_admin()) {
+			// user is trusted after permission checks above.
+			// tell XCache about it (the only secure way to by pass XCache http auth)
+			$_SERVER["PHP_AUTH_USER"] = "moo";
+			$_SERVER["PHP_AUTH_PW"] = "your-xcache-password-before-md5";
+		}
+		else {
+			die("Permission denied");
+		}
+	}
+	else {
 		if (!ask_the_user_to_login()) {
 			exit;
 		}
 	}
 
-	user_load_permissions();
-	if (!user_is_admin()) {
-		die("Permission denied");
-	}
-
-	// user is trusted after permission checks above.
-	// tell XCache about it (the only way to by pass XCache http auth)
-	$_SERVER["PHP_AUTH_USER"] = "moo";
-	$_SERVER["PHP_AUTH_PW"] = "your-xcache-password";
 	return true;
 }
 
@@ -65,7 +67,7 @@ check_admin_and_by_pass_xcache_http_auth();
 
 /* by pass XCache http auth
 $_SERVER["PHP_AUTH_USER"] = "moo";
-$_SERVER["PHP_AUTH_PW"] = "your-xcache-password";
+$_SERVER["PHP_AUTH_PW"] = "your-xcache-password-before-md5";
 */
 
 ?>