add remote debug example

1 files changed, 19 insertions, 0 deletions

diff --git a/examples/remote_debug.py b/examples/remote_debug.py
new file mode 100644
index 00000000..c5839d2c
--- /dev/null
+++ b/examples/remote_debug.py
@@ -0,0 +1,19 @@
+"""
+This script enables remote debugging of the mitmproxy *UI* with PyCharm.
+For general debugging purposes, it is easier to just debug mitmdump within PyCharm.
+
+Usage:
+    - pip install pydevd on the mitmproxy machine
+    - Open the Run/Debug Configuration dialog box in PyCharm, and select the Python Remote Debug configuration type.
+    - Debugging works in the way that mitmproxy connects to the debug server on startup.
+      Specify host and port that mitmproxy can use to reach your PyCharm instance on startup.
+    - Adjust this inline script accordingly.
+    - Start debug server in PyCharm
+    - Set breakpoints
+    - Start mitmproxy -s remote_debug.py
+"""
+
+
+def start():
+    import pydevd
+    pydevd.settrace("localhost", port=5678, stdoutToServer=True, stderrToServer=True)
\ No newline at end of file