You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bu...@apache.org on 2013/02/25 22:51:36 UTC
svn commit: r851936 - in /websites/staging/trafficserver/trunk: cgi-bin/
content/ content/docs/trunk/admin/getting-started/index.en.html
Author: buildbot
Date: Mon Feb 25 21:51:36 2013
New Revision: 851936
Log:
Staging update by buildbot for trafficserver
Modified:
websites/staging/trafficserver/trunk/cgi-bin/ (props changed)
websites/staging/trafficserver/trunk/content/ (props changed)
websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html
Propchange: websites/staging/trafficserver/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Feb 25 21:51:36 2013
@@ -1 +1 @@
-1442855
+1449916
Propchange: websites/staging/trafficserver/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Feb 25 21:51:36 2013
@@ -1 +1 @@
-1442855
+1449916
Modified: websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html
==============================================================================
--- websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html (original)
+++ websites/staging/trafficserver/trunk/content/docs/trunk/admin/getting-started/index.en.html Mon Feb 25 21:51:36 2013
@@ -60,26 +60,114 @@
<div class="row content">
<div class="eightcol">
<div id="content">
- <p>If your distribution does not come with a prepackaged Traffic Server, please
-refer to our <a href="https://cwiki.apache.org/confluence/display/TS">wiki</a>
-for <a href="https://cwiki.apache.org/confluence/display/TS/Building">build instructions</a></p>
-<p>After you have installed Traffic Server on your system, you can do any of the
-following:</p>
-<div class="toc">
+ <div class="toc">
<ul>
+<li><a href="#BeforeStart">Before you start</a></li>
+<li><a href="#Building">Building Traffic Server</a></li>
<li><a href="#StartTS">Start Traffic Server</a></li>
<li><a href="#StartTrafficLine">Start Traffic Line</a></li>
<li><a href="#StartTrafficShell">Start Traffic Shell</a></li>
<li><a href="#StopTS">Stop Traffic Server</a></li>
</ul>
</div>
+<h1 id="BeforeStart">Before you start</h1>
+<p>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](http://apr.apache.org/) to denote
+"stability" as Apache <a href="http://apr.apache.org/versioning.html">apr</a> and <a href="http://httpd.apache.org/dev/release.html">httpd</a> do: </p>
+<p>A version is made of a version-triplet: <em><code>MAJOR.MINOR.PATCH</code></em></p>
+<p>The most important thing that you need to know is that an even <em><code>MINOR</code></em> says
+that this is production stable release (such as 3.0.3 and 3.2.5) and an odd
+<em><code>MINOR</code></em> number means that the release is a release targeted at developers.</p>
+<p>If your distribution does not come with a prepackaged Traffic Server, please
+go to <a href="/downloads">downloads</a> 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 <a href="https://git-wip-us.apache.org/repos/asf/trafficserver.git">git repository</a>.</p>
+<p>Please note that while we do have a <a href="https://github.com/apache/trafficserver">GitHub Mirror</a>
+that you can also use to submit pull requests, it is only updated once a day.</p>
+<h1 id="Building">Building Traffic Server</h1>
+<p>In order to build Traffic Server from source you will need the following (development) packages:</p>
+<ul>
+<li>pkgconfig</li>
+<li>libtool</li>
+<li>gcc (or clang > 3.0)</li>
+<li>make (GNU Make!)</li>
+<li>openssl</li>
+<li>tcl</li>
+<li>expat</li>
+<li>pcre</li>
+<li>pcre</li>
+<li>libcap</li>
+<li>flex (for TPROXY)</li>
+<li>hwloc</li>
+<li>lua</li>
+</ul>
+<p>if you're building from a git clone, you'll also need</p>
+<ul>
+<li>git</li>
+<li>autoconf</li>
+<li>automake</li>
+</ul>
+<p>We will show-case a build from git:</p>
+<div class="codehilite"><pre> git clone https://git-wip-us.apache.org/repos/asf/trafficserver.git
+</pre></div>
+
+
+<p>Next, we <code>cd trafficserver</code> and run:</p>
+<div class="codehilite"><pre> autoreconf -if
+</pre></div>
+
+
+<p>This will generate a <code>configure</code> file from <code>configure.ac</code>, so now we can run that:</p>
+<div class="codehilite"><pre> ./configure --prefix=/opt/ats
+</pre></div>
+
+
+<p>Note well, that by default Traffic Server uses the user <code>nobody</code>, as well as user's
+primary group as Traffic Server user. If you want to change that, you can override it here:</p>
+<div class="codehilite"><pre> ./configure --prefix=/opt/ats --with-user=tserver
+</pre></div>
+
+
+<p>If dependencies are not in standard paths (<code>/usr/local</code> or <code>/usr</code>), you need to pass options
+to <code>configure</code> to account for that:</p>
+<div class="codehilite"><pre> ./configure --prefix=/opt/ats --with-user=tserver --with-lua=/opt/csw
+</pre></div>
+
+
+<p>Most <code>configure</code> path-options accept a format of <code>"INCLUDE_PATH:LIBRARY_PATH"</code>:</p>
+<div class="codehilite"><pre> ./configure --prefix=/opt/ats --with-user=tserver --with-lua=/opt/csw \
+ --with-pcre=/opt/csw/include:/opt/csw/lib/amd64
+</pre></div>
+
+
+<p>We can run <code>make</code> to build the project. We highly recommend to run <code>make check</code>
+to verify the build's general sanity:</p>
+<div class="codehilite"><pre> make
+ make check
+</pre></div>
+
+
+<p>We can finally run <code>make install</code> to install (you may have to switch to root to do this):</p>
+<div class="codehilite"><pre> sudo make install
+</pre></div>
+
+
+<p>We also recommend to run a regression test. Please note that this will only work
+successfully with the default <code>layout</code>:</p>
+<div class="codehilite"><pre> cd /opt/ats
+ sudo bin/traffic_server -R 1
+</pre></div>
+
+
+<p>After you have installed Traffic Server on your system, you can do any of the
+following:</p>
<h1 id="StartTS">Start Traffic Server</h1>
<p>To start Traffic Server manually, issue the <code>trafficserver</code> command, passing
in the attribute <code>start</code>. This command starts all the processes that work together
to process Traffic Server requests as well as manage, control, and monitor
the health of the Traffic Server system.</p>
<p>To run the <code>trafficserver start</code> command, e.g.:</p>
-<div class="codehilite"><pre> <span class="o">./</span><span class="n">trafficserver</span> <span class="n">start</span>
+<div class="codehilite"><pre> <span class="n">bin</span><span class="o">/</span><span class="n">trafficserver</span> <span class="n">start</span>
</pre></div>
@@ -88,12 +176,12 @@ the health of the Traffic Server system.
configuring the Traffic Server system via command-line interface. To execute
individual commands or script multiple commands, refer to <a href="../traffic-line-commands">Traffic Line Commands</a>.</p>
<p>Traffic Line commands take the following form:</p>
-<div class="codehilite"><pre> <span class="o">./</span><span class="n">traffic_line</span> <span class="o">-</span><span class="n">command</span> <span class="n">argument</span>
+<div class="codehilite"><pre> <span class="n">bin</span><span class="o">/</span><span class="n">traffic_line</span> <span class="o">-</span><span class="n">command</span> <span class="n">argument</span>
</pre></div>
<p>For a list of <code>traffic_line</code> commands, enter:</p>
-<div class="codehilite"><pre> <span class="o">./</span><span class="n">traffic_line</span> <span class="o">-</span><span class="n">h</span>
+<div class="codehilite"><pre> <span class="n">bin</span><span class="o">/</span><span class="n">traffic_line</span> <span class="o">-</span><span class="n">h</span>
</pre></div>
@@ -101,7 +189,7 @@ individual commands or script multiple c
<p>Traffic Shell is a command-line tool that enables you to monitor and configure
Traffic Server; it can be used instead of Traffic Line. Traffic Server provides
documentation for Traffic Shell in the form of manual (<code>man</code>) pages.</p>
-<div class="codehilite"><pre><span class="o">./</span><span class="n">start_traffic_shell</span>
+<div class="codehilite"><pre><span class="n">bin</span><span class="o">/</span><span class="n">start_traffic_shell</span>
</pre></div>
@@ -116,7 +204,7 @@ commands, and how to obtain documentatio
the attribute <code>stop</code>. This command stops all the Traffic Server processes (<code>traffic_manager</code>,
<code>traffic_server</code>, and <code>traffic_cop</code>). Do not manually stop processes, as this
can lead to unpredictable results.</p>
-<div class="codehilite"><pre><span class="o">./</span><span class="n">trafficserver</span> <span class="n">stop</span>
+<div class="codehilite"><pre><span class="n">bin</span><span class="o">/</span><span class="n">trafficserver</span> <span class="n">stop</span>
</pre></div>
</div>
</div>
@@ -147,7 +235,7 @@ can lead to unpredictable results.</p>
<div id="footer" class="row">
<div class="tencol">
- Copyright © 2012
+ Copyright © 2013
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
Licensed under
the <a href="http://www.apache.org/licenses/">Apache License</a>,