Permalink
Browse files

Markdown translation

  • Loading branch information...
1 parent 857d142 commit d111a9c9202a4a40f334afd72e3245298de8a408 @neuroo committed Mar 24, 2012
Showing with 33 additions and 36 deletions.
  1. +33 −36 README.md
View
@@ -1,57 +1,55 @@
-XPDBG - Taint based runtime analysis for PHP
-============================================
+# XPDBG - Taint based runtime analysis for PHP
-Explanation of XPDBG
---------------------
+## Explanation of XPDBG
This runtime analysis toolkit is divided in 3 components:
-- the tracer on the server-side
-- the trace aggregator and modeler (client-side)
-- the trace visualizer (client-side)
+* the tracer on the server-side
+* the trace aggregator and modeler (client-side)
+* the trace visualizer (client-side)
The server-side component is very raw:
-- Using Xdebug for PHP (with provided configuration)
-- Spits out the traces in one file (location to provide by the user)
+* Using Xdebug for PHP (with provided configuration)
+* Spits out the traces in one file (location to provide by the user)
The trace aggregator performs the following actions:
-- Connects in SSH to the server, and tails the trace file
-- It queries the SQLite database of taint names. In this context, taints are essentially
+* Connects in SSH to the server, and tails the trace file
+* It queries the SQLite database of taint names. In this context, taints are essentially
needles that need to be followed and trace in the entire application
-- Aggregates the traces of requests in one model (graph)
-- Generates a JSON file with slices of the graph that contains, or interact with the
+* Aggregates the traces of requests in one model (graph)
+* Generates a JSON file with slices of the graph that contains, or interact with the
taints (or needles)
The trace visualizer:
-- Browser based visualization
-- Only works on Firefox/Opera/IE (sorry, no Chrome)
-- Loads the local JSON file every N seconds, and displays interesting traces
-- Traces are displayed in two locations:
- - partial traces in the main view
- - actual xdebug trace is also dumped
+* Browser based visualization
+* Only works on Firefox/Opera/IE (sorry, no Chrome)
+* Loads the local JSON file every N seconds, and displays interesting trace
+* Traces are displayed in two locations:
+ ** partial traces in the main view
+ ** actual xdebug trace is also dumped
-Executing XPDBG
----------------
+## Executing XPDBG
+
Example of command line:
- $ xpdbg.py --host foobar.example.com
- --username dummy
- --remote /tmp/xdebug/trace.2043925204.xt
+ $ xpdbg.py --host foobar.example.com
+ --username dummy
+ --remote /tmp/xdebug/trace.2043925204.xt
Options:
- host server to connect using SSH
- username username to use for SSH connection (pwd to be prompted)
- remote remote location (on the server) of the trace file
+ * host: server to connect using SSH
+ * username: username to use for SSH connection (pwd to be prompted)
+ * remote: remote location (on the server) of the trace file
+ * The rest are in the source...
-Setting up Xdebug
------------------
+## Setting up Xdebug
Several options are available for Xdebug, but here is the configuration I usually
deploy:
-# XDebug config
-zend_extension=/usr/local/lib/php/extensions/xdebug.so
+ # XDebug config
+ zend_extension=/usr/local/lib/php/extensions/xdebug.so
[Xdebug]
xdebug.collect_params = 4
@@ -83,14 +81,13 @@ zend_extension=/usr/local/lib/php/extensions/xdebug.so
Please refer to the Xdebug documentation if any issues with Xdebug deployment
-XPDBG dependencies
-------------------
+## XPDBG dependencies
The distributed version of Xpdbg is quite old (developed in 2009). However, it should work
just fine with the current version of the following dependencies:
- - python-graph http://code.google.com/p/python-graph
- - twisted http://twistedmatrix.com
- - pygments http://pygments.org
+ * python-graph http://code.google.com/p/python-graph
+ * twisted http://twistedmatrix.com
+ * pygments http://pygments.org

0 comments on commit d111a9c

Please sign in to comment.