diff --git a/docs/src/content/overview-getting-started.md b/docs/src/content/overview-getting-started.md index 3f432bb71..10a4aa7dd 100644 --- a/docs/src/content/overview-getting-started.md +++ b/docs/src/content/overview-getting-started.md @@ -15,18 +15,19 @@ your machine. You can start any of our three tools from the command line / terminal. -* **mitmproxy** gives you an interactive TUI +* **mitmproxy** gives you an interactive command-line interface * **mitmweb** gives you a browser-based GUI -* **mitmdump** gives you a plain and simple terminal output +* **mitmdump** gives you non-interactive terminal output -In case you use the console-based version of mitmproxy, we highly recommend you to take the [tutorial]({{< relref "mitmproxytutorial-userinterface" >}}) to get started. +If you use the command-line interface, we highly recommend you to take the [tutorial]({{< relref "mitmproxytutorial-userinterface" >}}) to get started. ## Configure your browser or device -For the basic setup as [regular proxy]({{< relref -"concepts-modes#regular-proxy">}}), you need to configure your browser or device -to route all web traffic through mitmproxy as HTTP proxy. Browser versions and -configurations options frequently change, so we recommend to simply search the +Mitmproxy starts as a [regular HTTP proxy]({{< relref +"concepts-modes#regular-proxy">}}) by default and listens on `http://localhost:8080`. + +You need to configure your browser or device to route all traffic through mitmproxy. +Browser versions and configurations options frequently change, so we recommend to simply search the web on how to configure an HTTP proxy for your system. Some operating system have a global settings, some browser have their own, other applications use environment variables, etc. @@ -34,9 +35,8 @@ environment variables, etc. You can check that your web traffic is going through mitmproxy by browsing to http://mitm.it - it should present you with a [simple page]({{< relref "concepts-certificates#quick-setup">}}) to install the mitmproxy Certificate -Authority - which is also the next steps. Follow the instructions for your OS / -system and install the CA (and make sure to enable it, some system require -multiple steps!). +Authority - which is also the next step. Follow the instructions for your OS / +system and install the CA. ## Verifying everything works