diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 30 |
1 files changed, 16 insertions, 14 deletions
@@ -1,5 +1,6 @@ Bitmask ======= + *your internet encryption toolkit* .. image:: https://pypip.in/v/leap.bitmask/badge.png @@ -7,12 +8,13 @@ Bitmask **Bitmask** is the multiplatform desktop client for the services offered by `the LEAP Platform`_. + It is written in python using `PySide`_ and licensed under the GPL3. -Currently we distribute pre-compiled bundles for Linux and OSX, with Windows -bundles following soon. +Currently we distribute pre-compiled `bundles`_ for Linux, OSX and Windows. .. _`PySide`: http://qt-project.org/wiki/PySide .. _`the LEAP Platform`: https://github.com/leapcode/leap_platform +.. _`bundles`: https://downloads.leap.se/client/ Read the Docs! @@ -35,19 +37,26 @@ Bitmask depends on these libraries: Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip`` Getting dependencies under debian -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +++++++++++++++++++++++++++++++++++ With a Debian based system, to be able to run Bitmask you need to run the following command:: - $ sudo apt-get install openvpn python-pyside pyside-tools python-setuptools python-all-dev python-pip python-dev python-openssl + $ sudo apt-get install git python-dev python-setuptools + python-virtualenv python-pip python-openssl libsqlite3-dev g++ openvpn + pyside-tools python-pyside Installing ----------- -After getting the source and installing all the dependencies, proceed to install ``bitmask`` package:: +Quick install, from the cheese shop:: + + $ sudo pip install leap.bitmask + +If you prefer to install from sources:: + + $ make + $ sudo python2 setup.py install - $ make - $ sudo python2 setup.py install Running ------- @@ -100,13 +109,6 @@ Run Bitmask:: (bitmask)$ bitmask --debug - -If you are testing a new provider that doesn't have the proper certificates yet, you can use --danger flag, but **DO NOT use it on a regular basis**. - -**WARNING**: If you use the --danger flag you may be victim to a MITM_ attack without noticing. Use at your own risk. - -.. _MITM: http://en.wikipedia.org/wiki/Man-in-the-middle_attack - Testing ======= |