Repository: trafficserver
Updated Branches:
  refs/heads/master f49946eae -> d8d1b0871


Document the CONFIG proxy.config.http_ui_enabled option


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

Branch: refs/heads/master
Commit: d8d1b0871156ee10b20c375e9482ccd4a1ab638a
Parents: f49946e
Author: Thomas Jackson <[email protected]>
Authored: Thu Mar 26 16:29:48 2015 -0700
Committer: Thomas Jackson <[email protected]>
Committed: Thu Mar 26 16:31:19 2015 -0700

----------------------------------------------------------------------
 .../configuration/records.config.en.rst         | 30 +++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/d8d1b087/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst 
b/doc/reference/configuration/records.config.en.rst
index 4b741d5..cce3b6b 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -1556,7 +1556,35 @@ Customizable User Response Pages
 
 .. ts:cv:: CONFIG proxy.config.http_ui_enabled INT 0
 
-   Enable the user interface page.
+   Specifies which http UI endpoints to allow within :file:`remap.config`:
+
+   -  ``0`` = disable all http UI endpoints
+   -  ``1`` = enable only cache endpoints
+   -  ``2`` = enable only stats endpoints
+   -  ``3`` = enable all http UI endpoints
+
+   To enable any enpoint there needs to be an entry in :file:`remap.config` 
which
+   specifically enables it. Such a line would look like: ::
+
+        map / http://{stat}
+
+   The following are the cache endpoints:
+
+   - ``cache`` = UI to interact with the cache
+
+   The following are the stats endpoints:
+
+   - ``cache-internal`` = statistics about cache evacuation and volumes
+   - ``hostdb`` = lookups against the hostdb
+   - ``http`` = HTTPSM details, this endpoint is also gated by 
`proxy.config.http.enable_http_info`
+   - ``net`` = lookup and listing of open connections
+   - ``stat`` = list of all records.config options and metrics
+   - ``test`` = test callback page
+
+.. ts:cv:: CONFIG proxy.config.http.enable_http_info INT 0
+
+   Enables (``1``) or disables (``0``) access to an endpoint within 
`proxy.config.http_ui_enabled`
+   which shows details about inflight transactions (HttpSM).
 
 DNS
 ===

Reply via email to