From dd80e6083247446a44c22ac430620045aba287ef Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Mon, 2 Oct 2017 20:29:38 +0200 Subject: [docs] split development docs the page was becoming too cluttered. --- docs/hacking/privileges.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/hacking/privileges.rst (limited to 'docs/hacking/privileges.rst') diff --git a/docs/hacking/privileges.rst b/docs/hacking/privileges.rst new file mode 100644 index 0000000..3b63d35 --- /dev/null +++ b/docs/hacking/privileges.rst @@ -0,0 +1,24 @@ +.. _privileges: + +Privilege handling +================== + +For launching VPN and the firewall, Bitmask needs to run with administrative +privileges. In linux, ``bitmask_root`` is the component that runs with root +privileges. We currently depend on ``pkexec`` and ``polkit`` to execute it as +root. In order to do that, Bitmask needs to put some policykit helper files in a +place that is root-writeable. + +If you have installed Bitmask from some distro package, these folders should be +already in place. If you're running the Bitmask bundles, the first time you will +be prompted to authenticate to allow these helpers to be copied over (or any +time that these helpers change). + +However, if you're running bitmask in a headless environment, you will want to +copy the helpers manually, without involving pkexec. To do that, use:: + + sudo `which bitmask_helpers` install + +You can also uninstall them:: + + sudo `which bitmask_helpers` uninstall -- cgit v1.2.3