Docs and examples to top level

1 files changed, 22 insertions, 0 deletions

diff --git a/examples/redirect_requests.py b/examples/redirect_requests.py
new file mode 100644
index 00000000..c0a0ccba
--- /dev/null
+++ b/examples/redirect_requests.py
@@ -0,0 +1,22 @@
+"""
+This example shows two ways to redirect flows to other destinations.
+"""
+from mitmproxy.models import HTTPResponse
+from netlib.http import Headers
+
+def request(context, flow):
+    # pretty_host takes the "Host" header of the request into account,
+    # which is useful in transparent mode where we usually only have the IP
+    # otherwise.
+
+    # Method 1: Answer with a locally generated response
+    if flow.request.pretty_host.endswith("example.com"):
+        resp = HTTPResponse(
+            "HTTP/1.1", 200, "OK",
+            Headers(Content_Type="text/html"),
+            "helloworld")
+        flow.reply(resp)
+
+    # Method 2: Redirect the request to a different server
+    if flow.request.pretty_host.endswith("example.org"):
+        flow.request.host = "mitmproxy.org"