summaryrefslogtreecommitdiff
path: root/docs/dev/environment.rst
diff options
context:
space:
mode:
authorkali <kali@leap.se>2012-12-19 09:38:42 +0900
committerkali <kali@leap.se>2012-12-19 09:38:42 +0900
commit41a084823ebc967fcabb613a97e8d72c662dbe18 (patch)
tree37a225034c91775faf30f7f90fdb567adee33d14 /docs/dev/environment.rst
parent5c0eb246d468454de9e84dca0d08c813459a5a6d (diff)
added transifex config, updated some docs
Diffstat (limited to 'docs/dev/environment.rst')
-rw-r--r--docs/dev/environment.rst66
1 files changed, 58 insertions, 8 deletions
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst
index 7eafcdea..55696537 100644
--- a/docs/dev/environment.rst
+++ b/docs/dev/environment.rst
@@ -5,6 +5,16 @@ Setting up a Work Environment
This document covers how to get an enviroment ready to contribute code to the LEAP Client.
+Cloning the repo
+----------------
+.. note::
+ Stable releases will be in *master* branch (nothing there yet, move on!).
+ Development code lives in *develop* branch.
+
+::
+
+ git clone git://leap.se/leap_client
+
Base Dependencies
------------------
Leap client depends on these libraries:
@@ -14,21 +24,43 @@ Leap client depends on these libraries:
* `libgnutls`
* `openvpn`
+In debian-based systems::
+
+ $ apt-get install openvpn python-qt4 python-crypto python-gnutls
+
+To install the software from sources::
+
+ $ apt-get install python-pip python-dev libgnutls-dev
+
.. _virtualenv:
Working with virtualenv
-----------------------
-Intro to virtualenv
+Intro
^^^^^^^^^^^^^^^^^^^
-Virtualenv blah blah
+
+*Virtualenv* is the *Virtual Python Environment builder*.
+
+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/>`_.
+
+
+Create and activate your dev environment
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
+
+ $ virtualenv </path/to/new/environment>
+ $ source </path/to/new/environment>/bin/activate
Install python dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-You can install python dependencies with pip::
+You can install python dependencies with pip. If you do it inside your working environment, they will be installed avoiding the need for administrative permissions::
- $ apt-get install python-pip python-dev libgnutls-dev
$ pip install -r pkg/requirements.pip
.. _pyqtvirtualenv:
@@ -38,7 +70,7 @@ Troubleshooting PyQt install inside a virtualenv
If you attempt to install PyQt inside a virtualenv using pip, it will fail because PyQt4 does not use the standard setup.py mechanism.
-As a workaround, you can run the following script after creating your virtualenv. It will symlink to your global PyQt installation (`this is the recommended way if you are running a debian-based system`)::
+As a workaround, you can run the following script after creating your virtualenv. It will symlink to your global PyQt installation (*this is the recommended way if you are running a debian-based system*)::
$ pkg/postmkvenv.sh
@@ -52,8 +84,26 @@ Or, if you prefer, you can also download the official PyQt tarball and execute `
$ python configure.py
$ make && make install
+.. 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, ...).
-Cloning the repo
-----------------
-`XXX`
+
+.. _policykit:
+
+Running openvpn without root privileges
+---------------------------------------
+
+In linux, we are using ``policykit`` to be able to run openvpn without run privileges, and a policy file is needed to be installed for that to be possible.
+The setup script tries to install the policy file when installing the client system-wide, so if you have installed the client in your global site-packages at least once it should have copied this file for you.
+
+If you *only* are running the client from inside a virtualenv, you will need to copy this file by hand::
+
+ $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/net.openvpn.gui.leap.policy
+
+Missing Authentication agent
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you are running a desktop other than gnome or unity, you might get an error saying that you are not running the authentication agent. You can launch it like this::
+
+ /usr/lib/policykit-1-gnome/polkit-gnome-authentication-agent-1 &