mitmproxy/docs/scripting/mitmproxy.rst
Aldo Cortesi 08f44b9fad Doc tweaks
This patch does the following:

- Fixes all warnings in the doc tree
- Adds a modd + devd conf file that renders HTML and treats doc warnings as
errors. This lets you send warning output to your desktop notifier, and gives
livereload similar to the livehtml entry in the Makefile.
- Some small tweaks

Sphinx currently has a bug that causes unknown options to generate a warning:

https://github.com/sphinx-doc/sphinx/issues/2229

This is fixed in stable, but not yet released. You can update Sphinx to the
latest stable like so:

pip install --upgrade https://github.com/sphinx-doc/sphinx/archive/stable.zip
2016-02-21 11:47:17 +13:00

27 lines
1.0 KiB
ReStructuredText

mitmproxy
=========
.. note::
We strongly encourage you to use :ref:`inlinescripts` rather than mitmproxy.
- Inline Scripts are equally powerful and provide an easier syntax.
- Most examples are written as inline scripts.
- Multiple inline scripts can be used together.
- Inline Scripts can either be executed headless with mitmdump or within the mitmproxy UI.
All of mitmproxy's basic functionality is exposed through the **mitmproxy**
library. The example below shows a simple implementation of the "sticky cookie"
functionality included in the interactive mitmproxy program. Traffic is
monitored for ``Cookie`` and ``Set-Cookie`` headers, and requests are rewritten
to include a previously seen cookie if they don't already have one. In effect,
this lets you log in to a site using your browser, and then make subsequent
requests using a tool like curl, which will then seem to be part of the
authenticated session.
.. literalinclude:: ../../examples/stickycookies
:caption: examples/stickycookies
:language: python