doc/admin-guide/configuring-traffic-server.en.rst

.. _configuring-traffic-server:

Configuring Traffic Server
**************************

.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.

Traffic Server provides several options for configuring the system.

.. toctree::
   :maxdepth: 2

.. _configure-using-traffic-ctl:

Configure Traffic Server
========================

You can quickly and easily change your Traffic
Server configuration via command-line interface using :program:`traffic_ctl`.

View Configuration Options
--------------------------

To view a configuration setting, enter the following command::

    traffic_ctl config get VARIABLE

where *var* is the variable associated with the configuration
option. For a list of variables, refer to :ref:`configuration-variables`.

Change Configuration Options
----------------------------

To change the value of a configuration setting, enter the following
command::

    traffic_ctl config set VARIABLE VALUE

where *var* is the variable associated with the configuration option
and *value* is the value you want to use. For a list of the
variables, see :ref:`configuration-variables`.

Configure Traffic Server Using Configuration Files
==================================================

You can change
Traffic Server configuration options by manually editing specific
variables in :file:`records.yaml`.

Traffic Server must reread the configuration files for any changes to take effect.
This is done with :option:`traffic_ctl config reload`. Some configuration changes require a
full restart of Traffic Server.

The following is a sample portion of :file:`records.yaml`:


.. code-block:: yaml
   :linenos:

   diags:
      debug:
         enabled: 0
         tags: http|dns

   exec_thread:
      affinity: 1
      autoconfig:
         enabled: 1
         scale: 1.0
      limit: 2

   Sample records.yaml file

In addition to :file:`records.yaml`,
Traffic Server provides other configuration files that are used to
configure specific features. You can manually edit all configuration
files as described in :ref:`admin-configuration-files`.