Mirror of Apache Traffic Server
C++ C Python Lua M4 HTML Other
Permalink
Failed to load latest commit information.
build Created URI Signing Plugin. Nov 30, 2017
ci Cleans up the build, excludes ccache where it fails Dec 24, 2017
cmd clang-format cleanup Jan 6, 2018
contrib Ran autopep8 to python files Jun 15, 2017
doc Remove Congestion Control Feature Jan 16, 2018
example Issue #2883: Split TXN and SSN user arg allocation. Dec 18, 2017
iocore Fix UDPNetProcessor::CreateUDPSocket() Jan 17, 2018
lib Fix an enum element mismatch between TSServerState and ServerState_t Jan 14, 2018
mgmt Remove Congestion Control Feature Jan 16, 2018
plugins handle transport of empty body response Dec 28, 2017
proxy Avoid copying over data in the write_vio into response_buffer Jan 17, 2018
rc Ensure 'service trafficserver stop’ is synchronous under load on redhat Feb 28, 2017
tests appends missing dot to udns domain Jan 16, 2018
tools make it python3 compatible Nov 18, 2017
.clang-analyzer Better github PR support, and per-branch rules Apr 19, 2017
.clang-format Removed spaces at the end of the line on all files Feb 16, 2017
.clang-tidy Updated clang-tidy default config to be the option that have been com… May 25, 2017
.gitignore Add MIOBufferWriter class which writes to an MIOBuffer instance. Oct 19, 2017
.vimrc Change textwidth option to 132 so that it corresponds to the line len… Jun 14, 2017
CONTRIBUTING.md Removed spaces at the end of the line on all files Feb 16, 2017
CRUFT.txt TS-3170 First stab at cleaning out the mgmt web server stuff Jun 15, 2015
INSTALL Remove even more clustering bits May 9, 2017
LAYOUT Let's start by not claiming master refers to ATS 2.1... Feb 4, 2013
LICENSE Added the OpenSSL license Feb 18, 2017
Makefile.am YTSATS-1222: SNI based Configuration for traffic server Nov 14, 2017
NOTICE Add new testing infra to ATS Mar 5, 2017
README README: Alpine build instructions Nov 9, 2017
README-EC2 Change these two bad boys from DOS line feeds to real one... Nov 21, 2013
REVIEWERS Adding myself to HDRs reviewers May 21, 2014
STATUS Update STATUS Jul 26, 2016
Vagrantfile Update Vagrant with Fedora 24 Jul 18, 2016
config.layout TS-993: OpenBSD sbindir should be ${exec_prefix}/sbin Jan 26, 2017
configure.ac Build: Fix build problems on RHEL 6 for traffic_top. Dec 15, 2017
emacs-style TS-95: More RAT fixes and additions to the exclude file. Feb 9, 2010
setup.cfg Add settings for autopep8 Jun 15, 2017

README

Apache Traffic Server

Traffic Server is a high-performance building block for cloud services.
It's more than just a caching proxy server; it also has support for
plugins to build large scale web applications.

1. DIRECTORY STRUCTURE

  traffic/ ............... top src dir
  |-- ci/ ................ quality assurance and other CI tools and configs
  |-- cmd/ ............... various command applications
      |-- traffic_cop/ ..
      |-- traffic_crashlog/
      |-- traffic_ctl/ ... traffic_ctl command line management application
      |-- traffic_layout/
      |-- traffic_manager/
      |-- traffic_top/ ... traffic_top application
      |-- traffic_via/ ...
      |-- traffic_wccp/ ..
  |-- contrib ............ various contributed auxiliary pieces
  |-- doc/ ...............
      |-- admin/ ......... Admin guide documentations
      |-- dot/ ........... Graphviz source files for docs pictures
      |-- man/ ........... Unix style man-pages
      |-- plugins/ ....... Documentation for our core plugins
      |-- sdk/ ........... Plugin developer guide
  |-- example/ ........... example plugins
  |-- install/ ........... installation programs and scripts
  |-- iocore/ ............
      |-- aio/ ........... Asynchronous I/O core
      |-- cache/ ......... Disk and RAM cache
      |-- dns/ ........... DNS (asynchronous)
      |-- hostdb/ ........ Internal DNS cache
      |-- net/ ........... Network
  |-- lib/ ...............
      |-- cppapi/ ........ C++ api wrapper for plugin developers
      |-- records/ ....... library for config files
      |-- perl/ .......... Perl libraries for e.g. mgmt access and configurations
      |-- ts/ ............ Base / core library
      |-- tsconfig/....... New config parser and library (experimental)
      |-- wccp/ .......... WCCP implementation
  |-- m4/ ................ custom macros for configure.ac
  |-- mgmt/ .............. Management server and tools (including traffic_manager)
  |-- plugins/ ........... Stable core plugins
      |-- experimental/ .. Experimental core plugins
  |-- proxy/ ............. HTTP proxy logic
      |-- api/ ........... Plugin API includes
      |-- config/ ........ Configurations
      |-- congest/ ....... Congestion control
      |-- hdrs/ .......... Headers parsing and management
      |-- http/ .......... The actual HTTP protocol implementation
      |---http2/ ......... HTTP/2 implementation
      |-- logging/ ....... Flexible logging
  |-- README ............. intro, links, build info
  |-- README-EC2 ......... info on EC2 support
  |-- REVIEWERS .......... (incomplete) list of areas with committer interest
  |-- LICENSE ............ full license text
  `-- NOTICE ............. copyright notices

2. REQUIREMENTS

  This section outlines build requirements for different OS
  distributions. This may be out of date compared to the on-line
  requirements at

  <https://cwiki.apache.org/confluence/display/TS/Building>.

  As of ATS v7.0.0 and later, gcc 4.8.1 or later is required, since we now use
  and require the C++11 standard.

  Fedora / CentOS / RHEL:
    autoconf
    automake
    libtool
    pkgconfig
    perl-ExtUtils-MakeMaker
    gcc/g++ or clang/clang++
    openssl-devel
    tcl-devel
    pcre-devel
    ncurses-devel and libcurl-devel(optional, needed for traffic_top)
    libcap-devel (optional, highly recommended)
    hwloc-devel (optional, highly recommended)
    flex (optional, needed for e.g. WCCP)

  Ubuntu / Debian
    autoconf
    automake
    libtool
    pkg-config
    libmodule-install-perl
    gcc/g++ or clang/clang++
    libssl-dev
    tcl-dev
    libpcre3-dev
    libcap-dev (optional, highly recommended)
    libhwloc-dev (optional, highly recommended)
    libncurses5-dev (optional, required for e.g.: traffic_top)
    libcurl4-openssl-dev (optional, required for e.g.: traffic_top)
    flex (optional, required for e.g. WCCP)

  Alpine Linux
    build-base
    libexecinfo-dev
    pcre-dev
    libressl-dev
    autoconf
    automake
    libtool
    tcl-dev
    linux-headers
  
  OSX (we recommend HomeBrew):
    autoconf
    automake
    pkgconfig
    libtool
    tcl
    openssl
    pcre

  FreeBSD
    devel/gmake
    devel/autoconf
    devel/automake
    devel/pkgconf
    devel/libtool
    lang/tcl85
    security/openssl
    devel/pcre
    textproc/flex (optional, install newer version from ports, fix PATH)
    devel/hwloc (optional, highly recommended)

  OmniOS:
    developer/gcc46
    developer/build/gnu-make
    developer/build/autoconf
    developer/build/automake-111
    developer/build/libtool
    omniti/runtime/tcl-8
    library/security/openssl
    library/pcre

3. Building from distribution

You can download the latest source code from the official Apache Traffic
Server site:

       http://trafficserver.apache.org/downloads

(or via the URL shortener: http://s.apache.org/uG). Once downloaded,
follow the instructions:

   tar xf trafficserver-2.1.8-unstable.tar.bz2
   cd trafficserver-2.1.8-unstable
  ./configure            # configure the build environment to create Makefiles
  make                   # execute the compile

This will build with a destination prefix of /usr/local. You can finish
the installation with

  sudo make install

4. BUILDING FROM GIT REPO

  mkdir -p ~/dev         # make yourself a development dir
  cd ~/dev               # enter your development dir
  git clone ...          # get the source code from ASF Git repository
  cd trafficserver       # enter the checkout directory
  autoreconf -if         # generate the configure script and Makefile.in files
  ./configure            # configure the build environment to create Makefiles
  make                   # execute the compile

4b. Instructions for building on EC2
    NOTE: Alternately you may use the scripts under 'contrib' which will
          automate the install for trafficserver under EC2 which is
          HIGHLY RECOMMENDED. See 'README-EC2' for further details.

   # As root do the following when using Ubuntu
   mkdir -p /mnt          #EC2 Storage Mount, where storage is located
   cd /mnt
   git clone ...          # get the source code from ASF Git repo
   cd trafficserver       # enter the checkout dir
   autoreconf -i --force  # generate the configure script and Makefile.in files
   ./configure
   make

   # As root do the following when using Fedora Core 8 kernel
   mkdir -p /mnt          #EC2 Storage Mount, where storage is located
   cd /mnt
   git clone ...          # get the source code from ASF Git repo
   cd trafficserver       # enter the checkout dir
   autoreconf -i --force  # generate the configure script and Makefile.in files
   ./configure --disable-eventfd
   make

4c. Instructions for building on FreeBSD

   The only difference is how to run configure and make:

   MAKE=gmake ./configure # make sure that gmake is the make we use
   gmake

5. INSTALLATION

  DEFAULT DIR                        CONTENTS
  /usr/local/var/log/trafficserver   log files created at runtime
  /usr/local/var/trafficserver       runtime files
  /usr/local/etc/trafficserver       configuration files
  /usr/local/bin                     executable binaries
  /usr/local/libexec/trafficserver   plugins

6. CRYPTO NOTICE

  This distribution includes cryptographic software.  The country in
  which you currently reside may have restrictions on the import,
  possession, use, and/or re-export to another country, of
  encryption software.  BEFORE using any encryption software, please
  check your country's laws, regulations and policies concerning the
  import, possession, or use, and re-export of encryption software, to
  see if this is permitted.  See <http://www.wassenaar.org/> for more
  information.

  The U.S. Government Department of Commerce, Bureau of Industry and
  Security (BIS), has classified this software as Export Commodity
  Control Number (ECCN) 5D002.C.1, which includes information security
  software using or performing cryptographic functions with asymmetric
  algorithms.  The form and manner of this Apache Software Foundation
  distribution makes it eligible for export under the License Exception
  ENC Technology Software Unrestricted (TSU) exception (see the BIS
  Export Administration Regulations, Section 740.13) for both object
  code and source code.

  The following provides more details on the included cryptographic
  software:

    The functionality of OpenSSL <http://www.openssl.org/> is
    utilized in parts of the software.

7. ADDITIONAL INFO

  Web page: https://trafficserver.apache.org/
  Wiki: http://cwiki.apache.org/confluence/display/TS/
  User mailing list: users@trafficserver.apache.org