You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2013/07/25 00:03:36 UTC

[3/4] git commit: Updated build instructions, and indentation.

Updated build instructions, and indentation.


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/0430477b
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/0430477b
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/0430477b

Branch: refs/heads/master
Commit: 0430477b8ed533e69a925c2cb5e2176ee01d8b3c
Parents: da813f5
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 15:59:59 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 15:59:59 2013 -0600

----------------------------------------------------------------------
 doc/plugins/mysql_remap.en.rst | 28 +++++++++-------------------
 1 file changed, 9 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0430477b/doc/plugins/mysql_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/mysql_remap.en.rst b/doc/plugins/mysql_remap.en.rst
index 671e83b..6e7957e 100644
--- a/doc/plugins/mysql_remap.en.rst
+++ b/doc/plugins/mysql_remap.en.rst
@@ -23,14 +23,12 @@ This is a basic plugin for doing dynamic "remaps" from a database. It
 essentially rewrites the incoming request's Host header / origin server
 connection to one retrieved from a database.
 
-The generic proxying setup is the following:
+The generic proxying setup is the following::
 
-::
     UA ----> Traffic Server ----> Origin Server
 
-Without the plugin a request like:
+Without the plugin a request like::
 
-::
     GET /path/to/something HTTP/1.1
     Host: original.host.com
 
@@ -47,21 +45,17 @@ higher, up to the MySQL's max queries / second.
 Installation
 ============
 
-::
-    % make install
+This plugin is only built if the configure option ::
 
-should do it, assuming ``tsxs`` script in your search path. This script
-is installed with your installation of Apache Traffic Server.
+    --enable-experimental-plugins
 
-NOTE: you may need to open the Makefile and adjust the paths to MySQL
-client includes & libraries
+is given at build time.
 
 Configuration
 =============
 
-Import the default schema to a database you create:
+Import the default schema to a database you create::
 
-::
     mysql -u root -p -e "CREATE DATABASE mysql_remap;"   # create a new database
     mysql -u root -p mysql_remap < schema/import.sql     # import the provided schema
 
@@ -69,14 +63,12 @@ insert some interesting values in mysql_remap.hostname &
 mysql_remap.map
 
 Traffic Server plugin configuration is done inside a global
-configuration file: ``/etc/trafficserver/plugin.config``:
+configuration file: ``/etc/trafficserver/plugin.config``::
 
-::
     mysql_remap.so /etc/trafficserver/mysql_remap.ini
 
-The INI file should contain the following values:
+The INI file should contain the following values::
 
-::
     [mysql_remap]
     mysql_host     = localhost   #default
     mysql_port     = 3306        #default
@@ -84,10 +76,8 @@ The INI file should contain the following values:
     mysql_password = 
     mysql_database = mysql_remap #default
 
-To debug errors, start trafficserver manually using:
+To debug errors, start trafficserver manually using::
 
-::
     traffic_server -T "mysql_remap"
 
 And resolve any errors or warnings displayed.
-