summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-04-21 00:04:31 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-04-21 14:01:17 +0200
commitf31b9cab88c543f6b2b3910411a872ab0636e508 (patch)
tree7c7030d90a00df0024a9e7d1fe3bcb2afb53f3fd /docs
parentf0e267118ff40c01f04cc0b1ab9a5fdc9fe20368 (diff)
[docs] fix pixelated deps link in docs
Diffstat (limited to 'docs')
-rw-r--r--docs/hacking/index.rst5
-rw-r--r--docs/mail/index.rst26
2 files changed, 26 insertions, 5 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index 4420d9d1..ada3a78a 100644
--- a/docs/hacking/index.rst
+++ b/docs/hacking/index.rst
@@ -1,5 +1,6 @@
-:LastChangedDate: $LastChangedDate$ :LastChangedRevision: $LastChangedRevision$
- :LastChangedBy: $LastChangedBy$
+:LastChangedDate: $LastChangedDate$
+:LastChangedRevision: $LastChangedRevision$
+:LastChangedBy: $LastChangedBy$
Hacking
========================================
diff --git a/docs/mail/index.rst b/docs/mail/index.rst
index 0345830f..bd5cfa1c 100644
--- a/docs/mail/index.rst
+++ b/docs/mail/index.rst
@@ -71,16 +71,36 @@ reconstruct arbitrarily nested email structures easily.
Authentication
---------------------
-Currently, IMAP and SMTP are twisted services that are binded to ``localhost``. These services be initialized by the bitmask.core daemon, but they are not tied to any user session. When an use attempts to log in to those services, a ``twisted.cred`` pluggable authentication plugin will try to lookup a ``mail token`` that is stored inside the soledad encrypted storage.
+
+Currently, IMAP and SMTP are twisted services that are binded to ``localhost``.
+These services be initialized by the bitmask.core daemon, but they are not tied
+to any user session. When an use attempts to log in to those services, a
+``twisted.cred`` pluggable authentication plugin will try to lookup a ``mail
+token`` that is stored inside the soledad encrypted storage.
+
+From within the cli, you can get the mail token once you are authenticated
+with::
+
+ bitmaskctl mail get_token
+
+When launched, the bitmaskd daemon writes the tokens for each account to a file
+inside the folder named ``/tmp/bitmask_tokens``, and this is where the
+Thunderbird Extension reads them from.
Pixelated user agent
----------------------
+
From the 0.9.5 release, bundles are shipping the Pixelated User Agent. Until
some merge requests (dealing with packaging of the js resources) are merged
-upstream, you will need to install pixelated user agent from kali's repo::
+upstream, you will need to install pixelated user agent from leap's repo::
+
+ pip install pixelated_www pixelated_user_agent --find-links https://downloads.leap.se/libs/pixelated/
+
+Pixelated also needs a couple of extra dependencies::
+
+ pip install whoosh chardet requests==2.11.1
- pip install pixelated_www pixelated_user_agent --find-links https://devpi.net/kali/dev