12 Docs Structure
Aldo Cortesi edited this page 2015-03-14 12:31:44 +11:00
  • Introduction
    Introduce the project, the tools, how they differ and what they do.
  • Installation
    Something similar to https://cryptography.io/en/latest/installation/, recommend binaries where applicable.
  • Getting Started
    A quick walkthrough to demonstrate some of the main features, mostly the content of Tools/mitmproxy/Example and Tools/mitmdump/Examples.
    • mitmproxy (or mitmweb)
    • mitmdump
  • Proxy Modes
    "Modes of Operation" combined with "Features/Reverse Proxy" and "Features/Upstream proxy mode".
  • Installing Certificates
    Recommend the web app and ditch the tutorials for Firefox etc. They are hard to keep up to date and don't provide any value over the web app.
  • Tutorials
    Ideally, we'd have use-case oriented tutorials:
    • Debug an API
    • Inspect my smartphone
    • Pentesting Make sure to link to these from the quickstart.

  • Using mitmproxy
    • Anticache
    • Replacements
      • Header Replacements
    • Client-side replay
    • Server-side replay
    • Sticky Cookies
    • Filter Syntax
  • Configuration
    Config files, the configuration directory structure, where the CA lives
  • Proxy Options
    • Ignore domains
    • TCP proxy
    • Proxy authentication
    • Streaming Contents
    • SOCKS proxy
  • SSL Options
    Maybe just a single page detailing all ssl options.
    • Custom CA (from Installing Certificates/Overview)
    • Custom Cert (from Installing Certificates/Overview)
  • Scripting mitmproxy
    • Inline Scripts
    • libmproxy

  • How mitmproxy works
  • Development
    • Architecture
    • Dev Docs