From ea8e58f037c66fdf7523d4781720f182a1ed06da Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 25 Apr 2015 00:19:23 -0400 Subject: Re-org and added platform specific install from source docs, refs: mitmproxy/mitmproxy#398 --- doc-src/install.html | 64 ++++++++++++++++++++++++++++------------------------ 1 file changed, 34 insertions(+), 30 deletions(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index d5a01ca3..80298a4a 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,16 +1,35 @@ ## On This Page -* [Installation On Mac OS X](#docOSX) * [Installation On Ubuntu](#docUbuntu) +* [Installation On Mac OS X](#docOSX) * [Installation On Windows](#docWindows) -* [Installation From Source](#docSource) -## Installation On Mac OS X +## Installation On Ubuntu + +Ubuntu comes with Python but we need to install pip, python-dev and several libraries. This was tested on a fully patched installation of Ubuntu 14.04. -The easiest way to get up and running on OSX is to download the pre-built binary packages from [mitmproxy.org](http://mitmproxy.org). If you still want to install using pip, there are a few things to keep in mind: +
+$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev
 
-- If you're running a Python interpreter installed with homebrew (or similar), you may have to install some dependencies by hand. 
-- Make sure that XCode is installed from the App Store, and that the command-line tools have been downloaded (XCode/Preferences/Downloads).
+$ sudo pip install mitmproxy
+
+ +Once installation is complete you can run mitmproxy or mitmdump from a terminal. + +### Installation From Source + +If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, install the dependencies with apt: + +
+$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev
+
+ +Then see the Hacking section of the README on GitHub. + + +## Installation On Mac OS X + +The easiest way to get up and running on OSX is to download the pre-built binary packages from [mitmproxy.org](http://mitmproxy.org). 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 open program to create a simple and effective ~/.mailcap file to view request and response bodies: @@ -21,19 +40,16 @@ image/*; /usr/bin/open -Wn %s video/*; /usr/bin/open -Wn %s -From now on you can run mitmproxy or mitmdump from a terminal. - -## Installation On Ubuntu +Once installation is complete you can run mitmproxy or mitmdump from a terminal. -Ubuntu comes with Python but we need to install pip, python-dev and several libraries. This was tested on a fully patched installation of Ubuntu 14.04. +### Installation From Source -
-$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev
+If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, ithere are a few OS X specific things to keep in mind.
 
-$ sudo pip install mitmproxy
-
+- Make sure that XCode is installed from the App Store, and that the command-line tools have been downloaded (XCode/Preferences/Downloads). +- If you're running a Python interpreter installed with homebrew (or similar), you may have to install some dependencies by hand. -From now on you can run mitmproxy or mitmdump from a terminal. +Then see the Hacking section of the README on GitHub. ## Installation On Windows @@ -48,22 +64,10 @@ C:\> set PATH = C:\Python27;C:\Python27\Scripts;%PATH% C:\> pip install mitmproxy -From now on you can run mitmdump from a Command Prompt. - -## Installing From Source - -You can install mitmproxy with pip: +Once installation is complete you can run mitmdump from a Command Prompt. -
-$ pip install mitmproxy
-
- -If you also want to install the optional packages AMF, protobuf and CSS -content views, do this: +### Installation From Source -
-$ pip install "mitmproxy[contentviews]"
-
+If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, install Python as outlined above, then see the Hacking section of the README on GitHub. -If you are looking for a more information on how to install mitmproxy directly from the master branch on GitHub, or are wanting to set up mitmproxy for developement purposes, see the Hacking section of the README on GitHub. -- cgit v1.2.3