CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Administrator’s Guide — Apache Traffic Server documentation</title> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" /> <link rel="stylesheet" href="../_static/override.css" type="text/css" /> <link rel="shortcut icon" href="../_static/favicon.ico"/>  <script src="../_static/jquery.js"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/sphinx_highlight.js"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Introduction" href="introduction.en.html" /> <link rel="prev" title="ATS Release Procedure Steps" href="../release-notes/release-procedures.en.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="../index.html" class="icon icon-home"> Apache Traffic Server <img src="../_static/trans_logo_tm_380x69.png" class="logo" alt="Logo"/> </a> <div class="version"> 10.1.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../preface/index.en.html">Preface</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting-started/index.en.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../release-notes/index.en.html">Release Notes</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html">Installing Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/index.en.html">Proxy Cache Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="interaction/index.en.html">Interacting with Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html">Cache Storage</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/index.en.html">Plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/index.en.html">Logging</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/index.en.html">Monitoring</a></li> <li class="toctree-l2"><a class="reference internal" href="configuring-traffic-server.en.html">Configuring Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="layer-4-routing.en.html">Layer 4 Routing</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html">Performance Tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="files/index.en.html">Configuration Files</a></li> <li class="toctree-l2"><a class="reference internal" href="tools/index.en.html">Administrator tools</a></li> <li class="toctree-l2"><a class="reference internal" href="#audience">Audience</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../developer-guide/index.en.html">Developer’s Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendices/index.en.html">Appendices</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../index.html">Apache Traffic Server</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Administrator’s Guide</li> <li class="wy-breadcrumbs-aside"> <a href="../_sources/admin-guide/index.en.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="administrator-s-guide"> <span id="admin-guide"></span><h1>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this heading">¶</a></h1> <p>Table of Contents:</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="introduction.en.html">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html#ts-deployment-options">Traffic Server Deployment Options</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html#ts-components">Traffic Server Components</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html#traffic-analysis-options">Traffic Analysis Options</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html#ts-security-options">Traffic Server Security Options</a></li> <li class="toctree-l2"><a class="reference internal" href="introduction.en.html#tuning-ts">Tuning Traffic Server</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="installation/index.en.html">Installing Traffic Server</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#supported-platforms">Supported Platforms</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#traffic-server-versioning">Traffic Server Versioning</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#binary-distributions">Binary Distributions</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#building-from-source">Building From Source</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#start-traffic-server">Start Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/index.en.html#stop-traffic-server">Stop Traffic Server</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="configuration/index.en.html">Proxy Cache Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="configuration/session-protocol.en.html">Session Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/cache-basics.en.html">HTTP Proxy Caching</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/redirecting-http-requests.en.html">Reverse Proxy and HTTP Redirects</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/explicit-forward-proxying.en.html">Explicit Proxy Caching</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/transparent-proxy.en.html">Transparent Proxying</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/transparent-forward-proxying.en.html">Forward Proxy</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/hierarchical-caching.en.html">Hierarchical Caching</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/proxy-protocol.en.html">Proxy Protocol</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="interaction/index.en.html">Interacting with Traffic Server</a><ul> <li class="toctree-l2"><a class="reference internal" href="interaction/index.en.html#traffic-control">Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="interaction/index.en.html#stats-over-http">Stats Over HTTP</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="security/index.en.html">Security</a><ul> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#controlling-access">Controlling Access</a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#basic-ssl-termination">Basic SSL Termination</a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#mtls-en"><span class="xref std std-doc">mtls.en</span></a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#rotating-tls-session-ticket-keys">Rotating TLS Session Ticket Keys</a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#ocsp-stapling">OCSP Stapling</a></li> <li class="toctree-l2"><a class="reference internal" href="security/index.en.html#split-dns">Split DNS</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="storage/index.en.html">Cache Storage</a><ul> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#the-traffic-server-cache">The Traffic Server Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#the-ram-cache">The RAM Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#changing-the-size-of-the-ram-cache">Changing the Size of the RAM Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#changing-cache-capacity">Changing Cache Capacity</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#partitioning-the-cache">Partitioning the Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#configuring-the-cache-object-size-limit">Configuring the Cache Object Size Limit</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#clearing-the-cache">Clearing the Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#removing-an-object-from-the-cache">Removing an Object From the Cache</a></li> <li class="toctree-l2"><a class="reference internal" href="storage/index.en.html#pushing-an-object-into-the-cache">Pushing an Object into the Cache</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="plugins/index.en.html">Plugins</a><ul> <li class="toctree-l2"><a class="reference internal" href="plugins/index.en.html#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/index.en.html#stable-plugins">Stable plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/index.en.html#experimental-plugins">Experimental plugins</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="logging/index.en.html">Logging</a><ul> <li class="toctree-l2"><a class="reference internal" href="logging/understanding.en.html">Understanding Traffic Server Logs</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/destinations.en.html">Log Destinations</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/formatting.en.html">Formatting Log Files</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/cache-results.en.html">Logging Cache Results</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/rotation.en.html">Log Rotation and Retention</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/filters.en.html">Log Filters</a></li> <li class="toctree-l2"><a class="reference internal" href="logging/examples.en.html">Configuration Examples</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="monitoring/index.en.html">Monitoring</a><ul> <li class="toctree-l2"><a class="reference internal" href="monitoring/statistics/index.en.html">Statistics</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/monitoring/index.en.html">Monitoring</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/error-messages.en.html">Error Messages</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/diagnostic-files.en.html">traffic.out</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/diagnostic-files.en.html#diags-log">diags.log</a></li> <li class="toctree-l2"><a class="reference internal" href="monitoring/diagnostic-files.en.html#error-log">error.log</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="configuring-traffic-server.en.html">Configuring Traffic Server</a><ul> <li class="toctree-l2"><a class="reference internal" href="configuring-traffic-server.en.html#configure-traffic-server">Configure Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="configuring-traffic-server.en.html#configure-traffic-server-using-configuration-files">Configure Traffic Server Using Configuration Files</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="layer-4-routing.en.html">Layer 4 Routing</a><ul> <li class="toctree-l2"><a class="reference internal" href="layer-4-routing.en.html#transparency">Transparency</a></li> <li class="toctree-l2"><a class="reference internal" href="layer-4-routing.en.html#sni-routing">SNI Routing</a></li> <li class="toctree-l2"><a class="reference internal" href="layer-4-routing.en.html#pre-warming-tls-tunnel">Pre-warming TLS Tunnel</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="performance/index.en.html">Performance Tuning</a><ul> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#before-you-start">Before You Start</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#building-traffic-server">Building Traffic Server</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#hardware-tuning">Hardware Tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#operating-system-tuning">Operating System Tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#traffic-server-tuning">Traffic Server Tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#plugin-tuning">Plugin Tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="performance/index.en.html#common-scenarios-and-pitfalls">Common Scenarios and Pitfalls</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="files/index.en.html">Configuration Files</a></li> <li class="toctree-l1"><a class="reference internal" href="tools/index.en.html">Administrator tools</a></li> </ul> </div> <section id="audience"> <h2>Audience<a class="headerlink" href="#audience" title="Permalink to this heading">¶</a></h2> <p>This section of the Apache Traffic Server™ Manual is aimed at those individuals looking to install and configure Traffic Server for use as a caching proxy server. The section assumes basic knowledge of the command line and system administration tasks. Detailed steps are provided on how to build and configure the software, so even if you have never used a compiler or looked at a Makefile before, you will find everything you need in the following chapters to get you up and running with your own instance of Traffic Server. Or so is our hope.</p> <p>Should you encounter problems, or find any of the instructions unclear or lacking, please seek help through one of the avenues listed in <a class="reference internal" href="../preface/index.en.html#intro-other-resources"><span class="std std-ref">Other Resources</span></a>.</p> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="../release-notes/release-procedures.en.html" class="btn btn-neutral float-left" title="ATS Release Procedure Steps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="introduction.en.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2024, dev@trafficserver.apache.org.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> Apache Traffic Server</span> v: 10.1.0 <span class="fa fa-caret-down"></span> </span> <div class="rst-other-versions"> <dl id="lang-list"> <dt>Languages</dt> </dl> <dl id="version-list"> <dt>Versions</dt> </dl> </div> </div> <script> $(function() { function update_langlist (json) { for (var lang in json) { $('#lang-list').append('<dd><a href="/' + lang + '/latest/">' + json[lang]['name'] + '</a></dd>'); } for (var i in json[curlang]['versions']) { var ver = json[curlang]['versions'][i]; $('#version-list').append('<dd><a href="/' + curlang + '/' + ver + '/">' + ver + '</a></dd>'); } } var curlang = "en" == "None" ? "en" : "en"; $.ajax({ 'url': "/en/latest/_static/languages.json", 'dataType': "json", 'success': function (json) { update_langlist(json) }, 'error': function (xhr,errstr,e) { $.ajax({ 'url': "/_static/languages.json", 'dataType': "json", 'success': function (json) { update_langlist(json) } }) } }); }); </script> </body> </html>