Skip to content

Commit 01c0b08

Browse files
committed
update README to reflect some changes
1 parent cb2a996 commit 01c0b08

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.markdown

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,22 +53,28 @@ Installation
5353

5454
* Install your favourite mix of PHP and web server
5555
* Install MySQL server
56-
* Clone the project to some folder
56+
* Clone the project to some folder of your choice.
5757
* Map the sub folder `xhprof_html` to be accessible over HTTP
58-
* Move `xhprof_lib/config.sample.php` to `xhprof_lib/config.php`
58+
* You can do it with an Alias directive or (if symlinks are enabled) by just symlinking `xhprof_html` to any location within your document root.
59+
* Copy `xhprof_lib/config.sample.php` to `xhprof_lib/config.php`
60+
* Alternatively, you can copy the config.php to any place you like, and then specify the location of the config file in your ENV, in a PHP constant, or via Apache / Nginx Env variable (see below)
5961
* Edit `xhprof_lib/config.php`
60-
* Update the SQL server configuration
61-
* Update the URL of the service (should point to `xhprof_html` over HTTP)
62-
* Update the `dot_binary` configuration - otherwise no call graphs!
63-
* Update the `controlIPs` variable to enable access.
62+
* Update the SQL server configuration
63+
* Update the URL of the service (should point to `xhprof_html` over HTTP)
64+
* Update the `dot_binary` configuration - otherwise no call graphs!
65+
* Update the `controlIPs` variable to enable access.
6466
* For a development machine you can set this to `false` to disable IP checks.
6567
* Import the DB schema (it is just 1 table)
6668
* See the SQL at [xhprof_runs.php](https://github.com/toomasr/xhprof/blob/master/xhprof_lib/utils/xhprof_runs.php#L109)
6769
* Add a PHP configuration to enable the profiling
68-
* If using Apache you can edit your virtual host configuration
69-
* Add `php_admin_value auto_prepend_file "/path/to/xhprof/external/header.php"`
70+
* If using Apache you can edit your virtual host configuration
71+
* Add `php_admin_value auto_prepend_file "/path/to/xhprof/external/header.php"`
72+
* (optional) Add `SetEnv XHPROF_CONFIG /absolute/path/to/config.php` to your apache config to set location of config file for that host
73+
* (optional) If you include the header.php manually, you can define the location of the config file via define('XHPROF_CONFIG','/absolute/path/to/config.php');
74+
* (optional) Within a shell script, you can export `XHPROF_CONFIG=/absolute/path/to/config.php` to specify location of config file
7075
* Visit http://your-server/xhprof/xhprof_html/ and be amazed!
71-
* To get profiler information showing up there visit your page with a `GET` variable `_profile=1`.
76+
* To get profiler information showing up there visit your page with a `GET` variable `_profile=1`.
77+
This will enable it (via cookie) until you disable it by adding the parameter `_profile=0` to any url (or removing the _profile cookie manually)
7278
* For example `http://localhost/?_profile=1`
7379

7480
We Are Working On

0 commit comments

Comments
 (0)