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:34 UTC

[1/4] git commit: Fix indentation, and update install directions.

Updated Branches:
  refs/heads/master 4e55e5096 -> 9b021428c


Fix indentation, and update install directions.


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

Branch: refs/heads/master
Commit: 75242f35e8e9d570911eb75175d8d70f0adcf242
Parents: 4e55e50
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 15:55:09 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 15:55:09 2013 -0600

----------------------------------------------------------------------
 doc/plugins/cacheurl.en.rst | 25 +++++--------------------
 1 file changed, 5 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/75242f35/doc/plugins/cacheurl.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/cacheurl.en.rst b/doc/plugins/cacheurl.en.rst
index 3fe2ba6..2045b19 100644
--- a/doc/plugins/cacheurl.en.rst
+++ b/doc/plugins/cacheurl.en.rst
@@ -21,24 +21,10 @@ CacheURL Plugin
 
 
 This plugin allows you to change the key that is used for caching a
-request.
-
-It is designed so that multiple requests that have different URLs but
-the same content (for example, site mirrors) need be cached only once.
-
-Installation
-============
-
-::
-    make
-    sudo make install
-
-If you don't have the traffic server binaries in your path, then you
-will need to specify the path to tsxs manually:
-
-::
-    make TSXS=/opt/ts/bin/tsxs
-    sudo make TSXS=/opt/ts/bin/tsxs install
+request. It is designed so that multiple requests that have different
+URLs but the same content (for example, site mirrors) need be cached
+only once. The plugin is built and installed as part of the normal Apache
+Traffic Server installation process.
 
 Configuration
 =============
@@ -48,9 +34,8 @@ patterns to match. See the ``cacheurl.config.example`` file for what to
 put in this file.
 
 Add the plugin to your
-```plugins.config`` <../../configuration-files/plugins.config>`_ file:
+```plugins.config`` <../../configuration-files/plugins.config>`_ file::
 
-::
     cacheurl.so
 
 Start traffic server. Any rewritten URLs will be written to


[4/4] git commit: Updated indexing and build/config sections.

Posted by zw...@apache.org.
Updated indexing and build/config sections.


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

Branch: refs/heads/master
Commit: 9b021428cd0791a675d2e31621c18b2957f7fac7
Parents: 0430477
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 16:03:01 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 16:03:01 2013 -0600

----------------------------------------------------------------------
 doc/plugins/combo_handler.en.rst | 32 +++++++++++++++++++++-----------
 1 file changed, 21 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b021428/doc/plugins/combo_handler.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/combo_handler.en.rst b/doc/plugins/combo_handler.en.rst
index 11e4633..260d3f3 100644
--- a/doc/plugins/combo_handler.en.rst
+++ b/doc/plugins/combo_handler.en.rst
@@ -19,8 +19,23 @@ Combohandler Plugin
   under the License.
 
 
-This plugin provides that functionality (and more) with the same
-interface but with these differences in configuration:
+This plugin provides an intelligent way to combine multiple URLs into a single
+URL, and have Apache Traffic Server combine the components into one
+response. This is useful for example to create URLs that combine multiple CSS
+or Javascript files into one.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+    --enable-experimental-plugins
+
+is given at build time. Note that this plugin is built and installed in
+combination with the ESI module, since they share common code.
+
+Configuration
+=============
 
 The arguments in the
 ```plugin.config`` <../../configuration-files/plugin.config>`_ line in
@@ -38,14 +53,12 @@ default value be applied.
 Also, just like the original combohandler, this plugin generates URLs of
 the form ``http://localhost/<dir>/<file-path>``. ``<dir>`` here defaults
 to ``l`` unless specified by the file path in the query parameter using
-a colon. For example:
+a colon. For example::
 
-::
     http://combo.com/admin/v1/combo?filepath1&dir1:filepath2&filepath3
 
-Will result in these three pages being fetched:
+Will result in these three pages being fetched::
 
-::
     http://localhost/l/filepath1
     http://localhost/dir1/filepath2
     http://localhost/l/filepath3
@@ -57,14 +70,11 @@ The plugin also supports a prefix parameter. Common parts of successive
 file paths can be extracted and specified separately using a 'p' query
 parameter. Successive file path parameters are appended to this prefix
 to create complete file paths. The prefix will remain active until
-changed or cleared (set to an empty string). For example, the query
-
-::
+changed or cleared (set to an empty string). For example, the query ::
     "/file1&p=/path1/&file2&file3&p=&/file4&p=/dir:path2/&file5&file6"
 
-results in these file paths being "reconstructed":
+results in these file paths being "reconstructed"::
 
-::
     /file1
     /path1/file2
     /path1/file3


[2/4] git commit: Fix the build instructions to match reality.

Posted by zw...@apache.org.
Fix the build instructions to match reality.


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

Branch: refs/heads/master
Commit: da813f501ce63e88ac77ea8b8978131f82faf904
Parents: 75242f3
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 15:57:34 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 15:57:34 2013 -0600

----------------------------------------------------------------------
 doc/plugins/cacheurl.en.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/da813f50/doc/plugins/cacheurl.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/cacheurl.en.rst b/doc/plugins/cacheurl.en.rst
index 2045b19..093beac 100644
--- a/doc/plugins/cacheurl.en.rst
+++ b/doc/plugins/cacheurl.en.rst
@@ -23,8 +23,16 @@ CacheURL Plugin
 This plugin allows you to change the key that is used for caching a
 request. It is designed so that multiple requests that have different
 URLs but the same content (for example, site mirrors) need be cached
-only once. The plugin is built and installed as part of the normal Apache
-Traffic Server installation process.
+only once.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+    --enable-experimental-plugins
+
+is given at build time.
 
 Configuration
 =============


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

Posted by zw...@apache.org.
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.
-