summaryrefslogtreecommitdiff
path: root/docs/dev/quickstart.rst
blob: 978dc9e5dd4832bd2ece5b307ac8e8e6427ca69e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.. _quickstart:

Quickstart
==========

**Assumptions:** These instructions were made on a clean Ubuntu 12.04.3
system.

**Goal:** With minimal effort or reading install the necessary packages
to build the latest development code for ``bitmask_client``

**Outcome:** At the end of these instructions, you should be able to run
the latest development branch for bitmask client, getting the GUI in debug
mode and connect to a LEAP provider (bitmask.net)


Prerequisites
-------------

.. begin-debian-deps
::

    $ sudo apt-get install git python-dev python-setuptools
    python-virtualenv python-pip python-openssl libsqlite3-dev g++ openvpn
    pyside-tools python-pyside 
    
.. python-qt4  ??? (for translations)
.. TODO I'm pretty sure python-qt4 shoudln't be there...
   Nor libsqlite-dev, that's a bug in python-sqlcipher/soledad.


.. XXX any change HERE ^^^^ should be reflected also in README.rst.
   From any other place in the documentation, it should be just included.

.. end-debian-deps

Clone the repo into your working directory, and checkout development branch::

    $ git clone https://github.com/leapcode/bitmask_client
    $ cd bitmask_client
    $ git checkout develop


Create and activate the virtualenv, and symlink to your gloabal PySide install::

    $ virtualenv .
    $ source bin/activate
    $ pkg/postmkvenv.sh


Python libraries
----------------

.. TODO Check! -- this step should not be needed. setup develop should do it for you.
Install python requirements::

    $ pip install -r pkg/requirements.pip

Install the bitmask package in development mode inside the virtualenv::

    $ python2 setup.py develop

Compile the resource files::

    $ make resources

Copy necessary files into system folders, with root privileges::

    $ sudo mkdir -p /etc/leap
    $ sudo cp pkg/linux/resolv-update /etc/leap
    $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/


Running
--------

Run ``bitmask_client`` in debug mode::

    $ bitmask --debug  

You should see the ``bitmask_client`` window prompting to connect to an
existing node or add a new one. If not, something went wrong, maybe ask
on #leap-dev at irc.freenode.net