xref: /trafficserver/INSTALL (revision 17ea1d09)
1APACHE TRAFFIC SERVER UNIX QUICKSTART
2-------------------------------------
3
4For complete installation documentation, see the on-line documentation at
5
6    http://trafficserver.apache.org/docs
7
8
9Various popular platforms have up-to-date build instructions available
10online, at
11
12    https://cwiki.apache.org/confluence/display/TS/Building
13
14
15BUILD AND INSTALLATION
16----------------------
17
18Configure & Build from Git source tree:
19    $ autoreconf -if  # generate the configure script and Makefile.in files
20
21On Linux, OSX:
22    $ ./configure [--prefix=PREFIX]
23    $ make
24
25On OpenSolaris and FreeBSD:
26    $ ./configure [--prefix=PREFIX]
27    $ gmake
28
29To install:
30    $ sudo make install
31
32* Building on FreeBSD requires GNU make. This is the preferred make
33  on all platforms.
34
35* Replace PREFIX with the filesystem path under which Traffic Server
36  should be installed.  Default PREFIX is "/usr/local" (without the
37  quotes).
38
39* If you want to build using different layout see the config.layout
40  file for possible alternatives. You can create your own layout
41  and enable it with ./configure --enable-layout=ID, where ID is
42  the layout name you have created.
43
44* The easiest way to find all of the configuration flags
45  for Traffic Server is to run ./configure --help.
46
47
48By default the build will use the highest level of compiler
49optimization. To alter this, specify your own optimizer flags at
50configuration time:
51
52    $ ./configure CXXFLAGS=-Os CFLAGS=-Os
53
54To compile with an alternate set of compilers, e.g. LLVM/Clang
55
56    $ ./configure CC=clang CXX=clang++
57
58
59To start the Traffic Server process stack (TC, TM, TS):
60    $ sudo PREFIX/bin/trafficserver start
61
62
63INSTALLATION HELP
64-----------------
65
66The Apache Traffic Server group cannot field user's installation
67questions.  There are many valuable forums to help you get started.
68Please refer your questions to the appropriate forum, such as the
69Users Mailing List at
70
71    http://cwiki.apache.org/confluence/display/TS/Traffic+Server
72
73Thanks for using the Apache Traffic Server, version 5.
74
75             The Apache Software Foundation
76             http://www.apache.org/
77