From 13e6381c849ec0e05515c55a7e73bdc0ff7e5c42 Mon Sep 17 00:00:00 2001
From: "Kali Kaneko (leap communications)" <kali@leap.se>
Date: Wed, 14 Jun 2017 19:56:52 +0200
Subject: [docs] mention logs path for osx

---
 docs/hacking/index.rst |  5 +++++
 docs/hacking/osx.rst   | 46 ++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 49 insertions(+), 2 deletions(-)

(limited to 'docs')

diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
index 3a00f3e3..8bff694c 100644
--- a/docs/hacking/index.rst
+++ b/docs/hacking/index.rst
@@ -140,6 +140,8 @@ You can also uninstall them::
   sudo `which bitmask_helpers` uninstall 
 
 
+.. note: split a Contributing page on its own, this is getting too long/messy
+
 How to contribute code
 ---------------------------------
 
@@ -224,3 +226,6 @@ Some areas in which we always need contribution are:
 * Windows and OSX packaging (talk to kali)
 * Windows Firewall integration for VPN
 * Migrating components to py3 (look for vshyba or kali).
+* Minimal C++ Qt client (see `kali's bitmaskqt5 repo`_)
+
+.. _`kali's bitmaskqt5 repo`: https://github.com/kalikaneko/bitmaskqt5
diff --git a/docs/hacking/osx.rst b/docs/hacking/osx.rst
index 5b133f04..3d2d3329 100644
--- a/docs/hacking/osx.rst
+++ b/docs/hacking/osx.rst
@@ -27,7 +27,7 @@ After those fixes, you should be able to build the bundle::
 Privileged helper
 =================
 
-The OSX privileged helper is in ``src/leap/bitmask/vpn/fw/osx/``.
+The OSX privileged helper is in ``src/leap/bitmask/vpn/helpers/osx/``.
 
 .. note: move it to vpn/helpers/osx
 
@@ -62,18 +62,60 @@ 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``.
 
+
+OSX Firewall
+------------
+
+The OSX Firewall lives in ``src/leap/bitmask/vpn/helpers/osx/bitmask.pf.conf``. It gets
+installed to the same path mentioned in the previous section.
+
 .. note: cleanup unused helpers
 
 Installing the bundle with homebrew
 ===================================
 
-For testing purposes, homebrew can be used to distribute and install the
+For testing purposes, `homebrew`_ can be used to distribute and install the
 bundle. This should download and install the latest version of the bundle::
 
   brew install kalikaneko/bitmask/bitmask
+
+After that, you should be able to launch the bundle::
+
   bitmask
 
 
+.. _`homebrew`: https://brew.sh/
+
+
+Debug logs
+----------
+
+Bitmask rotates logs. The latest one can be found at::
+
+  /Users/<youruser>/Library/Preferences/leap/bitmaskd.log
+
+
+Known Issues
+------------
+
+The current state of the bundle that is distributed with homebrew is yet buggy,
+so it's in a pre-alpha state. Reports or bugfixes are welcome a this point.
+
+Major blockers for a usable homebrew distribution are:
+
+* OpenVPN is launched, but cannnot stopped https://0xacab.org/leap/bitmask-dev/issues/8924
+* Cannot find the gpg binary installed by homebrew https://0xacab.org/leap/bitmask-dev/issues/8934
+
+
+OSX Development Roadmap
+=======================
+
+1. Get a smooth 0.10 installation experience for power-users via homebrew.
+2. Merge bugfixes.
+3. Distribute Bitmask.pkg again, with the installer executing the same
+   installation scripts as homebrew Formula is doing.
+
+
 Other notes
 ===========
 
-- 
cgit v1.2.3