diff options
| -rw-r--r-- | docs/install.rst | 86 |
1 files changed, 37 insertions, 49 deletions
diff --git a/docs/install.rst b/docs/install.rst index 5c823ef4..b6160a9c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -9,25 +9,19 @@ 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. +This was tested on a fully patched installation of Ubuntu 16.04. .. code:: bash - sudo apt-get install python-pip python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev libjpeg8-dev zlib1g-dev g++ - sudo pip install mitmproxy # or pip install --user mitmproxy + sudo apt-get install python3-pip python3-dev libffi-dev libssl-dev libtiff5-dev libjpeg8-dev zlib1g-dev libwebp-dev + sudo pip3 install mitmproxy # or pip install --user mitmproxy -Once installation is complete you can run :ref:`mitmproxy` or :ref:`mitmdump` from a terminal. - -On **Ubuntu 12.04** (and other systems with an outdated version of pip), -you may need to update pip using ``pip install -U pip`` before installing mitmproxy. +On older Ubuntu versions, e.g., **12.04** and **14.04**, you may need to install a newer version of Python. +mitmproxy requires Python 3.5 or higher. Please take a look at pyenv_. +Make sure to have an up-to-date version of pip by running ``pip3 install -U pip``. -Installation From Source (Ubuntu) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Once installation is complete you can run :ref:`mitmproxy` or :ref:`mitmdump` from a terminal. -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 as you would for a regular -mitmproxy installation (see :ref:`install-ubuntu`). -Then see the Hacking_ section of the README on GitHub. .. _install-fedora: @@ -35,16 +29,19 @@ Installation On Fedora ---------------------- Fedora comes with Python but we need to install pip, python-dev and several libraries. -This was tested on a fully patched installation of Fedora 23. +This was tested on a fully patched installation of Fedora 24. .. code:: bash - sudo dnf install -y python-pip python-devel libffi-devel openssl-devel libxml2-devel libxslt-devel libpng-devel libjpeg-devel - sudo pip install mitmproxy # or pip install --user mitmproxy + sudo dnf install make gcc redhat-rpm-config python3-pip python3-devel libffi-devel openssl-devel libtiff-devel libjpeg-devel zlib-devel libwebp-devel openjpeg2-devel + sudo pip3 install mitmproxy # or pip install --user mitmproxy + +Make sure to have an up-to-date version of pip by running ``pip3 install -U pip``. Once installation is complete you can run :ref:`mitmproxy` or :ref:`mitmdump` from a terminal. + .. _install-arch: Installation On Arch Linux @@ -54,42 +51,25 @@ mitmproxy has been added into the [community] repository. Use pacman to install >>> sudo pacman -S mitmproxy +Once installation is complete you can run :ref:`mitmproxy` or :ref:`mitmdump` from a terminal. -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`_. +.. _install-macos: -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: +Installation On macOS +------------------------ -.. code-block:: none +You can use Homebrew to install everything: +.. code:: bash + brew install mitmproxy - application/*; /usr/bin/open -Wn %s - audio/*; /usr/bin/open -Wn %s - image/*; /usr/bin/open -Wn %s - video/*; /usr/bin/open -Wn %s +Or you can download the pre-built binary packages from `mitmproxy.org`_. Once installation is complete you can run :ref:`mitmproxy` or :ref:`mitmdump` from a terminal. -Installation From Source (Mac OS X) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -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, there are a few OS X specific things to keep in mind. - -- 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. -Then see the Hacking_ section of the README on GitHub. +.. _install-windows: Installation On Windows ----------------------- @@ -105,28 +85,36 @@ First, install the latest version of Python 3.5 from the `Python website`_. If you already have an older version of Python 3.5 installed, make sure to install pip_ (pip is included in Python by default). If pip aborts with an error, make sure you are using the current version of pip. ->>> python -m pip install --upgrade pip +.. code:: powershell + python -m pip install --upgrade pip Next, add Python and the Python Scripts directory to your **PATH** variable. You can do this easily by running the following in powershell: ->>> [Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python27;C:\Python27\Scripts", "User") +.. code:: powershell + [Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python27;C:\Python27\Scripts", "User") Now, you can install mitmproxy by running ->>> pip install mitmproxy +.. code:: powershell + pip install mitmproxy Once the installation is complete, you can run :ref:`mitmdump` from a command prompt. -Installation From Source (Windows) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. _install-source: + +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 Python as outlined above, then see the -Hacking_ section of the README on GitHub. +get set up to contribute to the project, install the dependencies as you would for a regular +mitmproxy installation. Then see the Hacking_ section of the README on GitHub. +You can check your system information by running: ``mitmproxy --sysinfo`` .. _Hacking: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst#hacking .. _mitmproxy.org: https://mitmproxy.org/ .. _`Python website`: https://www.python.org/downloads/windows/ .. _pip: https://pip.pypa.io/en/latest/installing.html +.. _pyenv: https://github.com/yyuu/pyenv |