From 8a0c8b2a0cfa2ad84113d1e041fa4ce4c8704ffc Mon Sep 17 00:00:00 2001
From: "Kali Kaneko (leap communications)" <kali@leap.se>
Date: Thu, 27 Apr 2017 20:00:50 +0200
Subject: [docs] update the manhole documentation

---
 docs/hacking/index.rst   |  5 +++++
 docs/hacking/manhole.rst | 24 ++++++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 docs/hacking/manhole.rst

(limited to 'docs/hacking')

diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index c9143bde..af3c5f25 100644
--- a/docs/hacking/index.rst
+++ b/docs/hacking/index.rst
@@ -104,6 +104,11 @@ This extension gets published to the `mozilla addons page`_.
 .. _`this repo`: https://0xacab.org/leap/bitmask_thunderbird
 .. _`mozilla addons page`: https://addons.mozilla.org/en-US/thunderbird/addon/bitmask
 
+Debugging Bitmask
+---------------------------------
+
+A must-read for debugging the Bitmask Core daemon is the :ref:`manhole HowTo <manhole>`.
+
 
 How to contribute code
 ---------------------------------
diff --git a/docs/hacking/manhole.rst b/docs/hacking/manhole.rst
new file mode 100644
index 00000000..cea3581d
--- /dev/null
+++ b/docs/hacking/manhole.rst
@@ -0,0 +1,24 @@
+.. _manhole:
+
+The manhole HowTo
+-------------------------------------------------
+
+Troubles with Bitmask Daemon? Don't panic! Just SSH into it
+
+If you want to inspect the objects living in your application memory, in
+realtime, you can ssh into it.
+
+For that, you must add the following section to your ``bitmaskd.cfg``
+configuration file::
+
+  [manhole]
+  user = bitmask
+  passwd = <yoursecret>
+  port = 22900
+
+
+And then you can ssh into your application::
+
+  ssh bitmask@localhost -p 22900
+
+Did I mention how *awesome* twisted is?? ``:)``
-- 
cgit v1.2.3