<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
<link href="01-bootstrap.min.css" type="text/css" rel="StyleSheet"/>
<link href="02-docstyle.css" type="text/css" rel="StyleSheet"/>
<link href="syntax.css" type="text/css" rel="StyleSheet"/>
<title>mitmproxy 0.9 - Installation</title></head><body><div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">mitmproxy 0.9 docs</a>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li><a href="index.html">Introduction</a></li>
<li class="active"><a href="install.html">Installation</a></li>
<li><a href="howmitmproxy.html">How mitmproxy works</a></li>
<li class="nav-header">Tools</li>
<li><a href="mitmproxy.html">mitmproxy</a></li>
<li><a href="mitmdump.html">mitmdump</a></li>
<li class="nav-header">Features</li>
<li><a href="features/anticache.html">Anticache</a></li>
<li><a href="features/clientreplay.html">Client-side replay</a></li>
<li><a href="features/filters.html">Filter expressions</a></li>
<li><a href="features/proxyauth.html">Proxy Authentication</a></li>
<li><a href="features/replacements.html">Replacements</a></li>
<li><a href="features/serverreplay.html">Server-side replay</a></li>
<li><a href="features/setheaders.html">Set Headers</a></li>
<li><a href="features/sticky.html">Sticky cookies and auth</a></li>
<li><a href="features/reverseproxy.html">Reverse proxy mode</a></li>
<li><a href="features/upstreamcerts.html">Upstream Certs</a></li>
<li class="nav-header">Installing Certificates</li>
<li><a href="ssl.html">Overview</a></li>
<li><a href="certinstall/firefox.html">Firefox</a></li>
<li><a href="certinstall/osx.html">OSX</a></li>
<li><a href="certinstall/windows7.html">Windows 7</a></li>
<li><a href="certinstall/ios.html">IOS</a></li>
<li><a href="certinstall/ios-simulator.html">IOS Simulator</a></li>
<li><a href="certinstall/android.html">Android</a></li>
<li class="nav-header">Transparent Proxying</li>
<li><a href="transparent.html">Overview</a></li>
<li><a href="transparent/linux.html">Linux</a></li>
<li><a href="transparent/osx.html">OSX</a></li>
<li class="nav-header">Tutorials</li>
<li><a href="tutorials/30second.html">Client playback: a 30 second example</a></li>
<li><a href="tutorials/gamecenter.html">Setting highscores on Apple's GameCenter</a></li>
<li class="nav-header">Scripting mitmproxy</li>
<li><a href="scripting/inlinescripts.html">Inline Scripts</a></li>
<li><a href="scripting/libmproxy.html">libmproxy</a></li>
<li class="nav-header">Hacking</li>
<li><a href="dev/testing.html">Testing</a></li>
</ul>
</div>
</div>
<div class="span9">
<div class="page-header">
<h1>Installation</h1>
</div>
<p>The preferred way to install mitmproxy - whether you're installing the latest
release or from source - is to use <a href="http://www.pip-installer.org/">pip</a>. If you
don't already have pip on your system, you can find installation instructions
<a href="http://www.pip-installer.org/en/latest/installing.html">here</a>.</p>
<h2>Installing the latest release</h2>
<p>A single command will download and install the latest release of mitmproxy,
along with all its dependencies:</p>
<pre class="terminal">
pip install mitmproxy
</pre>
<h2>Installing from source</h2>
<p>When installing from source, the easiest method is still to use pip. In this
case run:</p>
<pre class="terminal">
pip install /path/to/source
</pre>
<p>Note that if you're installing current git master, you will also have to
install the current git master of <a href="http://github.com/mitmproxy/netlib">netlib</a> by
hand.</p>
<h2>OSX</h2>
<ul>
<li>If you're running a Python interpreter installed with homebrew (or similar),
you may have to install some dependencies by hand. </li>
<li>Make sure that XCode is installed from the App Store, and that the
command-line tools have been downloaded (XCode/Preferences/Downloads).</li>
<li>Now use <strong>pip</strong> to do the installation, as above.</li>
</ul>
<p>There are a few bits of customization you might want to do to make mitmproxy
comfortable to use on OSX. The default color scheme is optimized for a dark
background terminal, but you can select a palette for a light terminal
background with the --palette option. You can use the OSX <b>open</b> program
to create a simple and effective <b>~/.mailcap</b> file to view request and
response bodies:</p>
<pre class="terminal">
application/*; /usr/bin/open -Wn %s
audio/*; /usr/bin/open -Wn %s
image/*; /usr/bin/open -Wn %s
video/*; /usr/bin/open -Wn %s
</pre>
</div>
</div>
<hr>
<footer>
<p>© mitmproxy project, 2013</p>
</footer>
</div>
</body></html>
