summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorelijah <elijah@riseup.net>2014-07-10 11:59:42 -0700
committerTomás Touceda <chiiph@leap.se>2014-07-21 12:03:36 -0300
commit2dd7e753ea6ba624ceb1ebad68a2e47e578aff80 (patch)
tree53a4f4a75553a4cd1350fe00bc905f8600af5432 /docs
parentd08a6963e2789eb869735785ff018ee9b670441c (diff)
bitmask-root: rip out all resolvconf code and simply rewrite all DNS packets to use the VPN nameserver.
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/environment.rst14
-rw-r--r--docs/dev/quickstart.rst2
-rw-r--r--docs/testers/howto.rst10
3 files changed, 6 insertions, 20 deletions
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst
index 0f6366ef..a3184b01 100644
--- a/docs/dev/environment.rst
+++ b/docs/dev/environment.rst
@@ -54,7 +54,7 @@ It is a tool to create isolated Python environments.
The basic problem being addressed is one of dependencies and versions, and indirectly permissions. Imagine you have an application that needs version 1 of LibFoo, but another application requires version 2. How can you use both these applications? If you install everything into /usr/lib/python2.7/site-packages (or whatever your platform's standard location is), it's easy to end up in a situation where you unintentionally upgrade an application that shouldn't be upgraded.
-Read more about it in the `project documentation page <http://pypi.python.org/pypi/virtualenv/>`_.
+Read more about it in the `project documentation page <http://pypi.python.org/pypi/virtualenv/>`_.
.. note::
this section could be completed with useful options that can be passed to the virtualenv command (e.g., to make portable paths, site-packages, ...). We also should document how to use virtualenvwrapper.
@@ -73,7 +73,7 @@ You first create a virtualenv in any directory that you like::
Note the change in the prompt.
-.. TODO use virtualenvwrapper + isis non-sudo recipe here
+.. TODO use virtualenvwrapper + isis non-sudo recipe here
.. _pysidevirtualenv:
@@ -143,16 +143,6 @@ You need to repeat this step each time you change a ``.ui`` file.
.. TODO need to make translations too?
-.. _copyscriptfiles:
-
-Copy script files
------------------
-
-The openvpn invocation expects some files to be in place. If you have not installed `bitmask` from a debian package, you must copy these files manually by now::
-
- $ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
-
.. _policykit:
Running openvpn without root privileges
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index a8be955e..d9c04a69 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -65,8 +65,6 @@ Compile the resource files::
Copy necessary files into system folders, with root privileges::
- (bitmask)$ sudo mkdir -p /etc/leap
- (bitmask)$ sudo cp pkg/linux/resolv-update /etc/leap
(bitmask)$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst
index d9536632..a7a72b7f 100644
--- a/docs/testers/howto.rst
+++ b/docs/testers/howto.rst
@@ -67,7 +67,7 @@ Launch Bitmask in debug mode. Logs are way more verbose that way::
Get your hand on the logs. You can achieve that either by clicking on the "Show
log" button, and saving to file, or directly by specifying the path to the
logfile in the command line invocation::
-
+
bitmask --debug --logfile /tmp/bitmask.log
Attach the logfile to your bug report.
@@ -99,7 +99,7 @@ painlessly fetch the latest development code.
We have put together a script to allow rapid testing in different platforms for
the brave souls like you. It more or less does all the steps covered in the
:ref:`Setting up a Work Enviroment <environment>` section, only that in a more
-compact way suitable (ahem) also for non developers.
+compact way suitable (ahem) also for non developers.
.. note::
@@ -127,7 +127,7 @@ Download and source the following script in the parent folder where you want you
.. code-block:: bash
- cd /tmp
+ cd /tmp
wget https://raw.github.com/leapcode/bitmask_client/develop/pkg/scripts/bitmask_bootstrap.sh
source bitmask_bootstrap.sh
@@ -142,7 +142,7 @@ Activating the virtualenv
The above bootstrap script has fetched latest code inside a virtualenv, which is
an isolated, *virtual* python local environment that avoids messing with your
global paths. You will notice you are *inside* a virtualenv because you will see
-a modified prompt reminding it to you (*bitmask-testbuild* in this case).
+a modified prompt reminding it to you (*bitmask-testbuild* in this case).
Thus, if you forget to *activate your virtualenv*, bitmask will not run from the
local path, and it will be looking for something else in your global path. So,
@@ -162,8 +162,6 @@ Copying config files
If you have never installed ``bitmask`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files <copyscriptfiles>` and :ref:`running openvpn without root privileges <policykit>` sections for more info on this. In short::
$ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/
- $ sudo mkdir -p /etc/leap
- $ sudo cp pkg/linux/resolv-update /etc/leap
Local config files
^^^^^^^^^^^^^^^^^^^