diff options
| author | Aldo Cortesi <aldo@corte.si> | 2018-05-17 08:03:24 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-17 08:03:24 +1200 |
| commit | df9240f260c5f53936c8b4575d7f927e98bd6666 (patch) | |
| tree | 0653a5c1ce8fd9b8c558c90cf0276a5a9b032457 /docs/src | |
| parent | a38497ac36aa72f0e431205d9c2b0394368d0810 (diff) | |
| parent | 615d606da9703979df6d997d529abd8ebd9b8576 (diff) | |
| download | mitmproxy-df9240f260c5f53936c8b4575d7f927e98bd6666.tar.gz mitmproxy-df9240f260c5f53936c8b4575d7f927e98bd6666.tar.bz2 mitmproxy-df9240f260c5f53936c8b4575d7f927e98bd6666.zip | |
Merge pull request #3128 from cortesi/pdocs
docs - installation and minor updates
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/content/concepts-modes.md | 1 | ||||
| -rw-r--r-- | docs/src/content/overview-installation.md | 16 |
2 files changed, 11 insertions, 6 deletions
diff --git a/docs/src/content/concepts-modes.md b/docs/src/content/concepts-modes.md index 7a0b835a..44c701c0 100644 --- a/docs/src/content/concepts-modes.md +++ b/docs/src/content/concepts-modes.md @@ -213,3 +213,4 @@ tests). ## SOCKS Proxy +In this mode, mitmproxy acts as a SOCKS5 proxy. diff --git a/docs/src/content/overview-installation.md b/docs/src/content/overview-installation.md index 62762db4..4b300d72 100644 --- a/docs/src/content/overview-installation.md +++ b/docs/src/content/overview-installation.md @@ -36,15 +36,19 @@ the repository maintainers directly for issues with native packages. ## Windows -The recommended way to install mitmproxy on Windows is to download our -binary-packages from our -[releases](https://github.com/mitmproxy/mitmproxy/releases/latest) page. -FIXME: WSL +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 binary packages from our +[releases](https://github.com/mitmproxy/mitmproxy/releases/latest) page. 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. The console interface is not supported on native Windows. +command line. # Advanced Installation @@ -54,7 +58,7 @@ command line. The console interface is not supported on native Windows. For some platforms we provide pre-built binary packages containing ready-to-run executables. This includes a self-contained Python 3 environment, a recent OpenSSL that support ALPN and HTTP/2, and other dependencies that would -otherwise we cumbersome to compile and install. +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 |