diff options
| author | Kali Kaneko (leap communications) <kali@leap.se> | 2017-04-27 20:00:50 +0200 |
|---|---|---|
| committer | Kali Kaneko (leap communications) <kali@leap.se> | 2017-05-01 16:13:14 +0200 |
| commit | 8a0c8b2a0cfa2ad84113d1e041fa4ce4c8704ffc (patch) | |
| tree | 3a7f26e0486ee5dbc6586b89313b5ffb879d694a /docs | |
| parent | 5009f2c227ab55d70022f24f7f32299e26fd11ea (diff) | |
[docs] update the manhole documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 1 | ||||
| -rw-r--r-- | docs/hacking/index.rst | 5 | ||||
| -rw-r--r-- | docs/hacking/manhole.rst | 24 | ||||
| -rw-r--r-- | docs/mail/hacking.rst | 22 |
4 files changed, 30 insertions, 22 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index 0a478bea..04c43445 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -19,6 +19,7 @@ Features - VPN and Mail status displayed in the UI - Port Pixelated UA integration from legacy bitmask - Add Pixelated Button to the UI +- Add ability to ssh into the bitmask daemon for debug Bugfixes ~~~~~~~~ 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?? ``:)`` diff --git a/docs/mail/hacking.rst b/docs/mail/hacking.rst index 27087e52..10e3dbcb 100644 --- a/docs/mail/hacking.rst +++ b/docs/mail/hacking.rst @@ -6,28 +6,6 @@ Hacking on Bitmask Mail Some hints oriented to `leap.mail` hackers. These notes are mostly related to the imap server, although they probably will be useful for other pieces too. -Don't panic! Just manhole into it ---------------------------------- - - -If you want to inspect the objects living in your application memory, in -realtime, you can manhole into it. - -First of all, check that the modules ``PyCrypto`` and ``pyasn1`` are installed -into your system, they are needed for it to work. - -You just have to pass the ``LEAP_MAIL_MANHOLE=1`` enviroment variable while -launching the client:: - - LEAP_MAIL_MANHOLE=1 bitmask --debug - -And then you can ssh into your application! (password is "leap"):: - - ssh boss@localhost -p 2222 - -Did I mention how *awesome* twisted is?? ``:)`` - - Profiling ---------- |