summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKali Kaneko (leap communications) <kali@leap.se>2017-06-09 15:12:41 +0200
committerKali Kaneko (leap communications) <kali@leap.se>2017-06-12 18:13:21 +0200
commite4764fb1ed3eb46b6e29cf53455b8b20c5a86331 (patch)
treea2b9bae185212d1f7bc60b92e2b189cf861f8155 /docs
parent739facb24e1fe8bbcdaca219c9d831c90c999f54 (diff)
[docs] documentation about helpers
Diffstat (limited to 'docs')
-rw-r--r--docs/hacking/osx.rst39
1 files changed, 35 insertions, 4 deletions
diff --git a/docs/hacking/osx.rst b/docs/hacking/osx.rst
index e80f1d9..8b438e0 100644
--- a/docs/hacking/osx.rst
+++ b/docs/hacking/osx.rst
@@ -3,7 +3,7 @@
Setting up a development environment in OSX™
============================================
-(work in progress)
+.. note: work in progress
* Make sure you're using a new enough version of pip (1.8 or newest).
This will make all the problems with ``cryptography`` going away, since it will
@@ -19,6 +19,26 @@ workaround in an issue in qutebrowser's repo, works fine for me for now::
https://raw.githubusercontent.com/Homebrew/homebrew/f802822b0fa35ad362aebd0101ccf83a638bed37/Library/Formula/{py,}qt5.rb
brew install qt5 pyqt5
+Privileged helper
+=================
+
+The OSX privileged helper is in ``src/leap/bitmask/vpn/fw/osx/``.
+
+.. note: move it to vpn/helpers/osx
+
+It is a python daemon that runs as root.
+It should be installed by the Bitmask installer.
+
+If you have to stop it::
+
+ sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist
+
+
+And, to load it again::
+
+ sudo launchctl load /Library/LaunchDaemons/se.leap.bitmask-helper.plist
+
+
Debugging bitmask-helper
------------------------
@@ -30,15 +50,26 @@ tear down the firewall after a crash), you can do it like this with
echo 'firewall_stop/CMD' | socat - UNIX-CONNECT:/tmp/bitmask-helper.socket
+Other helpers
+-------------
+
+There are other helpers that the installer drops in a well-know path.
+These are shipped in ``pkg/osx``, and copied to
+``/Applications/Bitmask.app/Contents/Resources``.
+
+.. note: cleanup unused helpers
+
+
Other notes
------------
+===========
-PySide vs QtWebKit:
+PySide vs QtWebKit
+------------------
http://qtwebkit.blogspot.nl/2016/08/qtwebkit-im-back.html
Running OSX on KVM
-==================
+------------------
The following notes are not yet tested, but might be useful for development.