Merge pull request #2890 from mitmproxy/newdocs

All new documentation

1 files changed, 28 insertions, 0 deletions

diff --git a/examples/addons/options-configure.py b/examples/addons/options-configure.py
new file mode 100644
index 00000000..c7638e87
--- /dev/null
+++ b/examples/addons/options-configure.py
@@ -0,0 +1,28 @@
+import typing
+
+from mitmproxy import ctx
+from mitmproxy import exceptions
+
+
+class AddHeader:
+    def load(self, loader):
+        loader.add_option(
+            name = "addheader",
+            typespec = typing.Optional[int],
+            default = None,
+            help = "Add a header to responses",
+        )
+
+    def configure(self, updates):
+        if "addheader" in updates:
+            if ctx.options.addheader is not None and ctx.options.addheader > 100:
+                raise exceptions.OptionsError("addheader must be <= 100")
+
+    def response(self, flow):
+        if ctx.options.addheader is not None:
+            flow.response.headers["addheader"] = str(ctx.options.addheader)
+
+
+addons = [
+    AddHeader()
+]