[[TracNav(DocTOC)]]
[[PageOutline]]
= How to Install XCache Administration Page =

XCache Administration Page (referenced as admin-page below) is an important web interface that you can monitor and operate your opcode cache, seeing how well(or bad) it goes.

== Installing XCache ==
Before you can use admin-page, XCache must be installed as either extension or zend_extension in php.

See: InstallFromSource or InstallFromBinary, and PhpIni

== Generating your auth password ==
Admin-page is protected by http-auth, it is disabled if you haven't yet set a password. The user/pass of http-auth can be set in php.ini (see PhpIni). But you have to md5(your password) first.

setup a php page with webserver
====== Password generator ======
{{{
#!php
<?php
echo md5("password");
?>
}}}
request it from browser and get 5f4dcc3b5aa765d61d8327deb882cf99. So update php.ini:

====== Example admin auth setting ======
{{{
xcache.admin.user = "mOo"
xcache.admin.pass = "5f4dcc3b5aa765d61d8327deb882cf99"
}}}

This is an example only. Use your own password to get your own md5 string.

== Setting up web interface ==
The fastest and simplest way to do so is copying your the whole directory xcache/htdocs/ (was admin/ in older release)  to your web document-root or sub-directory of it.
====== Simply copy to install (for example only) ======
{{{
#!ShellExample
$ cp -a ~/src/xcache/htdocs /var/www/example.com/htdocs/xcache-admin
(or)
$ cp -a /usr/share/xcache/htdocs /var/www/example.com/htdocs/xcache-admin
}}}

Request it from your browser, a http-auth prompt will popup. Fill your user/pass in, and it's done.

If you're installing XCache with os distro package manager, rpm/apt-get/emerge etc, you might want to do a "alias" in webserver instead of copying the scripts, to stay admin-page up to date when the package is updated.

====== Lighttpd setting (for example only) ======
{{{
alias.url += ("/xcache-admin/" => "/usr/share/xcache/htdocs/")
}}}

Note: check open_basedir (if enabled) against /usr/share/xcache/

Restart php, and your webserver if needed, and check it out from your browser.

== Customizing your config.php ==
WARNING: This is for advanced user only.

Copy config.php.example to config.php, read the inline comments. It should be simple if you have php programming skill.