summaryrefslogtreecommitdiff
path: root/docs/hacking
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-04-27 20:00:50 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-05-01 16:13:14 +0200
commit8a0c8b2a0cfa2ad84113d1e041fa4ce4c8704ffc (patch)
tree3a7f26e0486ee5dbc6586b89313b5ffb879d694a /docs/hacking
parent5009f2c227ab55d70022f24f7f32299e26fd11ea (diff)
[docs] update the manhole documentation
Diffstat (limited to 'docs/hacking')
-rw-r--r--docs/hacking/index.rst5
-rw-r--r--docs/hacking/manhole.rst24
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index c9143bd..af3c5f2 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 0000000..cea3581
--- /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?? ``:)``