trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1449916 - /trafficserver/site/trunk/content/docs/trunk/admin/getting-started/index.en.mdtext
Date Mon, 25 Feb 2013 21:51:27 GMT
Author: igalic
Date: Mon Feb 25 21:51:27 2013
New Revision: 1449916

Add on to getting-startet telling people how to actually get startet

We explain how to install Traffic Server from scratch, before starting it ;)


Modified: trafficserver/site/trunk/content/docs/trunk/admin/getting-started/index.en.mdtext
--- trafficserver/site/trunk/content/docs/trunk/admin/getting-started/index.en.mdtext (original)
+++ trafficserver/site/trunk/content/docs/trunk/admin/getting-started/index.en.mdtext Mon
Feb 25 21:51:27 2013
@@ -17,15 +17,110 @@ Notice:    Licensed to the Apache Softwa
            under the License.
 Navigation: [*](*)
+# Before you start # {#BeforeStart}
+Before you get started with Traffic Server you may have to decide which version
+you want to use. Traffic Server uses the same "semantic versioning](
to denote
+"stability" as Apache [apr]( and [httpd](
+A version is made of a version-triplet: *`MAJOR.MINOR.PATCH`*
+The most important thing that you need to know is that an even *`MINOR`* says
+that this is production stable release (such as 3.0.3 and 3.2.5) and an odd
+*`MINOR`* number means that the release is a release targeted at developers.
 If your distribution does not come with a prepackaged Traffic Server, please
-refer to our [wiki](
-for [build instructions](
+go to [downloads](/downloads) to choose the version that you consider
+most appropriate for yourself. If you want to really be on the bleeding edge
+you can clone our [git repository](
+Please note that while we do have a [GitHub Mirror](
+that you can also use to submit pull requests, it is only updated once a day.
+# Building Traffic Server {#Building}
+In order to build Traffic Server from source you will need the following (development) packages:
+* pkgconfig
+* libtool
+* gcc (or clang > 3.0)
+* make (GNU Make!)
+* openssl
+* tcl
+* expat
+* pcre
+* pcre
+* libcap
+* flex (for TPROXY)
+* hwloc
+* lua
+if you're building from a git clone, you'll also need
+* git
+* autoconf
+* automake
+We will show-case a build from git:
+     :::text
+     git clone
+Next, we `cd trafficserver` and run:
+     :::text
+     autoreconf -if
+This will generate a `configure` file from ``, so now we can run that:
+     :::text
+     ./configure --prefix=/opt/ats
+Note well, that by default Traffic Server uses the user `nobody`, as well as user's
+primary group as Traffic Server user. If you want to change that, you can override it here:
+     :::text
+     ./configure --prefix=/opt/ats --with-user=tserver
+If dependencies are not in standard paths (`/usr/local` or `/usr`), you need to pass options
+to `configure` to account for that:
+     :::text
+     ./configure --prefix=/opt/ats --with-user=tserver --with-lua=/opt/csw
+Most `configure` path-options accept a format of `"INCLUDE_PATH:LIBRARY_PATH"`:
+     :::text
+     ./configure --prefix=/opt/ats --with-user=tserver --with-lua=/opt/csw \
+        --with-pcre=/opt/csw/include:/opt/csw/lib/amd64
+We can run `make` to build the project. We highly recommend to run `make check`
+to verify the build's general sanity:
+     :::text
+     make
+     make check
+We can finally run `make install` to install (you may have to switch to root to do this):
+     :::text
+     sudo make install
+We also recommend to run a regression test. Please note that this will only work
+successfully with the default `layout`:
+     :::text
+     cd /opt/ats
+     sudo bin/traffic_server -R 1
 After you have installed Traffic Server on your system, you can do any of the
 # Start Traffic Server # {#StartTS}
@@ -36,7 +131,7 @@ the health of the Traffic Server system.
 To run the `trafficserver start` command, e.g.:
-        ./trafficserver start
+        bin/trafficserver start
 # Start Traffic Line # {#StartTrafficLine}
@@ -46,11 +141,11 @@ individual commands or script multiple c
 Traffic Line commands take the following form:
-     ./traffic_line -command argument
+     bin/traffic_line -command argument
 For a list of `traffic_line` commands, enter:
-     ./traffic_line -h
+     bin/traffic_line -h
 # Start Traffic Shell  # {#StartTrafficShell}
@@ -58,7 +153,7 @@ Traffic Shell is a command-line tool tha
 Traffic Server; it can be used instead of Traffic Line. Traffic Server provides
 documentation for Traffic Shell in the form of manual (`man`) pages.
-    ./start_traffic_shell
+    bin/start_traffic_shell
 The `man` page describes how to use Traffic Shell, how to obtain a list of available
 commands, and how to obtain documentation about each command.
@@ -73,5 +168,5 @@ the attribute `stop`. This command stops
 `traffic_server`, and `traffic_cop`). Do not manually stop processes, as this
 can lead to unpredictable results.
-    ./trafficserver stop
+    bin/trafficserver stop

View raw message