diff options
Diffstat (limited to 'docs/src/content/overview-installation.md')
| -rw-r--r-- | docs/src/content/overview-installation.md | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/docs/src/content/overview-installation.md b/docs/src/content/overview-installation.md index 5b94adfc..1cdf62ad 100644 --- a/docs/src/content/overview-installation.md +++ b/docs/src/content/overview-installation.md @@ -34,20 +34,18 @@ the repository maintainers directly for issues with native packages. ## Windows - -All the mitmproxy tools are fully supported under -[WSL (Windows Subsystem for Linux)](https://docs.microsoft.com/en-us/windows/wsl/about). -We recommend to [install WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10), and then -follow the mitmproxy installation instructions for Linux. +All the mitmproxy tools are fully supported under [WSL (Windows Subsystem for +Linux)](https://docs.microsoft.com/en-us/windows/wsl/about). We recommend to +[install WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10), and +then follow the mitmproxy installation instructions for Linux. We also distribute native Windows packages for all tools other than the -mitmproxy console app, which only works under WSL. To install mitmproxy on Windows, -download the installer from [mitmproxy.org](https://mitmproxy.org/). +mitmproxy console app, which only works under WSL. To install mitmproxy on +Windows, download the installer from [mitmproxy.org](https://mitmproxy.org/). After installation, you'll find shortcuts for mitmweb and mitmdump in the start menu. Both executables are added to your PATH and can be invoked from the command line. - # Advanced Installation ## Development Setup @@ -57,7 +55,6 @@ GitHub master branch, please see the our [README](https://github.com/mitmproxy/mitmproxy#installation) on GitHub. - ## Installation from the Python Package Index (PyPI) If your mitmproxy addons require the installation of additional Python packages, @@ -65,10 +62,10 @@ you can install mitmproxy from [PyPI](https://pypi.org/project/mitmproxy/). While there are plenty of options around[^1], we recommend the installation using pipx: -[^1]: If you are familiar with the Python ecosystem, you may know that there are a million ways to install Python - packages. Most of them (pip, virtualenv, pipenv, etc.) should just work, but we don't have the capacity to +[^1]: If you are familiar with the Python ecosystem, you may know that there are a million ways to install Python + packages. Most of them (pip, virtualenv, pipenv, etc.) should just work, but we don't have the capacity to provide support for it. - + 1. Install a recent version of Python (we require at least 3.6). 2. Install [pipx](https://pipxproject.github.io/pipx/). 3. `pipx install mitmproxy` @@ -82,8 +79,10 @@ You can use the official mitmproxy images from ## Security Considerations for Binary Packages -Our pre-compiled binary packages and Docker images include a self-contained Python 3 environment, a recent version of -OpenSSL that support ALPN and HTTP/2, and other dependencies that would otherwise be cumbersome to compile and install. +Our pre-compiled binary packages and Docker images include a self-contained +Python 3 environment, a recent version of OpenSSL that support ALPN and HTTP/2, +and other dependencies that would otherwise be cumbersome to compile and +install. Dependencies in the binary packages are frozen on release, and can't be updated in situ. This means that we necessarily capture any bugs or security issues that @@ -92,4 +91,4 @@ dependencies (though we may do so if we become aware of a really serious issue). If you use our binary packages, please make sure you update regularly to ensure that everything remains current. -As a general principle, mitmproxy does not "phone home" and consequently will not do any update checks.
\ No newline at end of file +As a general principle, mitmproxy does not "phone home" and consequently will not do any update checks. |