From fb0e2bf1f98f824a8161f8434ec7cffc4255fea1 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 16:45:48 -0400 Subject: Cleaned up Ubuntu docs and added Windows installation information --- doc-src/install.html | 48 ++++++++++++++++++++++++++++------------ doc-src/winppythoninstaller.jpg | Bin 0 -> 46628 bytes 2 files changed, 34 insertions(+), 14 deletions(-) create mode 100644 doc-src/winppythoninstaller.jpg (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 682e317e..2e9de63b 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,20 +1,19 @@ ## Installing from source -The preferred way to install mitmproxy - whether you're installing the latest -release or from source - is to use [pip](http://www.pip-installer.org/). If you -don't already have pip on your system, you can find installation instructions -[here](http://www.pip-installer.org/en/latest/installing.html). +The preferred way to install mitmproxy - whether you're installing the latest release or from source - is to use [pip](http://www.pip-installer.org/). If you don't already have pip on your system, you can find installation instructions [here](http://www.pip-installer.org/en/latest/installing.html). + +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. 
-pip install mitmproxy
+$ sudo pip install mitmproxy
If you also want to install the optional packages AMF, protobuf and CSS content views, do this: 
-pip install "mitmproxy[contentviews]"
+$ sudo pip install "mitmproxy[contentviews]"
@@ -46,14 +45,35 @@ video/*; /usr/bin/open -Wn %s ## Ubuntu -On Ubuntu, you will need the following native packages to install mitmproxy -from source: +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. + +
+$ sudo apt-get python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev
+
+$ sudo pip install mitmproxy
+
+ + +## Windows + +mitmweb and mitmdump are the only parts of mitmproxy that work on Windows. -- build-essential -- python-dev -- libffi-dev -- libssl-dev -- libxml2-dev -- libxslt1-dev +Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straight forward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. One option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. + +Now log out of Windows and back in to finish having Python added to your PATH. + +
+C:\> pip install mitmproxy
+
+ +From that point you just run mitmweb or mitmdump from the Command Prompt + +
+C:\> mitmweb
+
+or +
+C:\> mitmdump
+
diff --git a/doc-src/winppythoninstaller.jpg b/doc-src/winppythoninstaller.jpg new file mode 100644 index 00000000..0473c66a Binary files /dev/null and b/doc-src/winppythoninstaller.jpg differ -- cgit v1.2.3 From 1a5f0e944ee724d39d4814a8414b35f91cfcdf9a Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 17:21:43 -0400 Subject: Fixed english and made each OS consistent --- doc-src/install.html | 18 ++++++------------ doc-src/winppythoninstaller.jpg | Bin 46628 -> 0 bytes 2 files changed, 6 insertions(+), 12 deletions(-) delete mode 100644 doc-src/winppythoninstaller.jpg (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 2e9de63b..246b3c46 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -6,14 +6,14 @@ The preferred way to install mitmproxy - whether you're installing the latest re 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. 
-$ sudo pip install mitmproxy
+$ pip install mitmproxy
If you also want to install the optional packages AMF, protobuf and CSS content views, do this: 
-$ sudo pip install "mitmproxy[contentviews]"
+$ pip install "mitmproxy[contentviews]"
@@ -42,6 +42,7 @@ image/*; /usr/bin/open -Wn %s video/*; /usr/bin/open -Wn %s +From now on you can run mitmproxy, mitmweb or mitmdump from a terminal. ## Ubuntu @@ -53,10 +54,11 @@ $ sudo apt-get python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1- $ sudo pip install mitmproxy +From now on you can run mitmproxy, mitmweb or mitmdump from a terminal. ## Windows -mitmweb and mitmdump are the only parts of mitmproxy that work on Windows. +Please note that mitmweb and mitmdump are the only components of mitmproxy that work on Windows. Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straight forward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. One option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. @@ -67,13 +69,5 @@ Now log out of Windows and back in to finish having Python added to your PATH. C:\> pip install mitmproxy -From that point you just run mitmweb or mitmdump from the Command Prompt - -
-C:\> mitmweb
-
-or -
-C:\> mitmdump
-
+From now on you can just run mitmweb or mitmdump from the Command Prompt. diff --git a/doc-src/winppythoninstaller.jpg b/doc-src/winppythoninstaller.jpg deleted file mode 100644 index 0473c66a..00000000 Binary files a/doc-src/winppythoninstaller.jpg and /dev/null differ -- cgit v1.2.3 From 4731c1bb795d2afd20ded0a99f91e03216764ec5 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 17:25:31 -0400 Subject: Fixed image name and moved it into the screenshots folder --- doc-src/screenshots/winpythoninstaller.jpg | Bin 0 -> 46628 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc-src/screenshots/winpythoninstaller.jpg (limited to 'doc-src') diff --git a/doc-src/screenshots/winpythoninstaller.jpg b/doc-src/screenshots/winpythoninstaller.jpg new file mode 100644 index 00000000..0473c66a Binary files /dev/null and b/doc-src/screenshots/winpythoninstaller.jpg differ -- cgit v1.2.3 From 5b6fb64e60bee85f764e60881d67d0d53164f8d5 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 19:02:37 -0400 Subject: cleaned up Installing from source section. --- doc-src/install.html | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 246b3c46..e4193542 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,9 +1,7 @@ ## Installing from source -The preferred way to install mitmproxy - whether you're installing the latest release or from source - is to use [pip](http://www.pip-installer.org/). If you don't already have pip on your system, you can find installation instructions [here](http://www.pip-installer.org/en/latest/installing.html). - -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. +You can install mitmproxy with pip: 
 $ pip install mitmproxy
@@ -16,24 +14,17 @@ content views, do this:
 $ pip install "mitmproxy[contentviews]"
+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. + ## OSX -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: - -- 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). - -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: +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: + +- 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). + +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: 
 application/*; /usr/bin/open -Wn %s
-- 
cgit v1.2.3


From 3117dd77339334a7ee45bbd9707c1776f7436852 Mon Sep 17 00:00:00 2001
From: Jim Shaver 
Date: Sat, 11 Apr 2015 19:41:16 -0400
Subject: Removed mitmweb referrences and added On This Page section

---
 doc-src/install.html | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

(limited to 'doc-src')

diff --git a/doc-src/install.html b/doc-src/install.html
index e4193542..f2fd15ec 100644
--- a/doc-src/install.html
+++ b/doc-src/install.html
@@ -1,5 +1,11 @@
+## On This Page
 
-## Installing from source
+* [Installation From Source](#docSource)
+* [Installation On Mac OS X](#docOSX)
+* [Installation On Ubuntu](#docUbuntu)
+* [Installation On Windows](#docWindows)
+
+## Installing From Source
 
 You can install mitmproxy with pip:
 
@@ -16,8 +22,7 @@ $ pip install "mitmproxy[contentviews]"
 
 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. 
 
-
-## OSX
+## 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). If you still want to install using pip, there are a few things to keep in mind:
 
@@ -33,9 +38,9 @@ image/*; /usr/bin/open -Wn %s
 video/*; /usr/bin/open -Wn %s
-From now on you can run mitmproxy, mitmweb or mitmdump from a terminal. +From now on you can run mitmproxy or mitmdump from a terminal. -## Ubuntu +## 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. @@ -45,13 +50,13 @@ $ sudo apt-get python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1- $ sudo pip install mitmproxy -From now on you can run mitmproxy, mitmweb or mitmdump from a terminal. +From now on you can run mitmproxy or mitmdump from a terminal. -## Windows +## Installation On Windows -Please note that mitmweb and mitmdump are the only components of mitmproxy that work on Windows. +Please note that mitmdump is the only component of mitmproxy that is supported on Windows. -Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straight forward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. One option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. +Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straightforward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. For the most part, you can accept the defaults but one option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. Now log out of Windows and back in to finish having Python added to your PATH. @@ -60,5 +65,5 @@ Now log out of Windows and back in to finish having Python added to your PATH. C:\> pip install mitmproxy -From now on you can just run mitmweb or mitmdump from the Command Prompt. +From now on you can run mitmdump from a Command Prompt. -- cgit v1.2.3 From 4a6bdb25642c6849b6023241dc1ce90479938dae Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 22:17:26 -0400 Subject: added the most important part of "sudo apt-get install ..." to the docs --- doc-src/install.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index f2fd15ec..a5732461 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -45,7 +45,7 @@ From now on you can run mitmproxy or -$ sudo apt-get python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev +$ sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev $ sudo pip install mitmproxy -- cgit v1.2.3 From a63634254dc2adff6556187dde8800deb4c6f3d3 Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Sat, 11 Apr 2015 23:17:07 -0400 Subject: Removed logging out added setting variables manually. --- doc-src/install.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index a5732461..7010016f 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -59,9 +59,9 @@ Please note that mitmdump is the only component of mitmproxy that is supported o Install the latest version of Python 2 from the Python website. The Windows MSI installer is fairly straightforward and even includes pip as long as you are installing a version of Python 2 after 2.7.9. For the most part, you can accept the defaults but one option you should change during installation is "Add python.exe to Path". This will make it easier to run Python. -Now log out of Windows and back in to finish having Python added to your PATH. - 
+C:\> set PATH = C:\Python27;C:\Python27\Scripts;%PATH%
+
 C:\> pip install mitmproxy
-- cgit v1.2.3 From bfe57ae1133cb2015d9c6c338652a3ce04375e0f Mon Sep 17 00:00:00 2001 From: Jim Shaver Date: Tue, 21 Apr 2015 10:39:57 -0400 Subject: Moved installing from Source to the bottom. --- doc-src/install.html | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'doc-src') diff --git a/doc-src/install.html b/doc-src/install.html index 7010016f..d5a01ca3 100644 --- a/doc-src/install.html +++ b/doc-src/install.html @@ -1,26 +1,9 @@ ## On This Page -* [Installation From Source](#docSource) * [Installation On Mac OS X](#docOSX) * [Installation On Ubuntu](#docUbuntu) * [Installation On Windows](#docWindows) - -## Installing From Source - -You can install mitmproxy with pip: - -
-$ pip install mitmproxy
-
- -If you also want to install the optional packages AMF, protobuf and CSS -content views, do this: - -
-$ pip install "mitmproxy[contentviews]"
-
- -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. +* [Installation From Source](#docSource) ## Installation On Mac OS X @@ -67,3 +50,20 @@ C:\> pip install mitmproxy From now on you can run mitmdump from a Command Prompt. +## Installing From Source + +You can install mitmproxy with pip: + +
+$ pip install mitmproxy
+
+ +If you also want to install the optional packages AMF, protobuf and CSS +content views, do this: + +
+$ pip install "mitmproxy[contentviews]"
+
+ +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 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