diff options
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/install.rst | 62 | ||||
| -rw-r--r-- | docs/user/intro.rst | 18 | ||||
| -rw-r--r-- | docs/user/leap-color-small.png | bin | 0 -> 10100 bytes | |||
| -rw-r--r-- | docs/user/running.rst | 9 |
4 files changed, 70 insertions, 19 deletions
diff --git a/docs/user/install.rst b/docs/user/install.rst index da1d914c..b5fb7810 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -4,28 +4,51 @@ Installation ============ This part of the documentation covers the installation of Bitmask. -We assume that you want to get it properly installed before being able to use it. +We assume that you want to get it properly installed before being able to use it. But we can we wrong. +Standalone bundle +----------------- + +Maybe the quickest way of running Bitmask in your machine is using the standalone bundle. That is the recommended way to use Bitmask for the time being. + +You can get the latest bundles, and their matching signatures at `the downloads page <https://downloads.leap.se/client/>`_. + +Linux +^^^^^ +- `Linux 32 bits bundle`_ (`signature <https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2.asc>`_) +- `Linux 64 bits bundle`_ (`signature <https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2.asc>`_) + +OSX +^^^ +- `OSX bundle`_ (`signature <https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg.asc>`_) + +Windows +^^^^^^^ .. note:: - The recommended way of installing in the near future will be the standalone bundles, but those are not quite ready yet. Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`. + The release of the bundles for Windows is delayed right now. We should resume + producing them shortly, keep tuned. +Signature verification +^^^^^^^^^^^^^^^^^^^^^^ -Distribute & Pip ----------------- +For the signature verification you can use :: -.. warning:: The package in the cheese shop is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead. + $ gpg --verify Bitmask-linux64-latest.tar.bz2.asc -Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions :: +Asuming that you downloaded the linux 64 bits bundle. - $ pip install bitmask +.. _`Linux 64 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2 +.. _`Linux 32 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2 +.. _`OSX bundle`: https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg +.. _`Windows bundle`: https://downloads.leap.se/client/windows/Bitmask-windows-latest.zip Debian package -------------- .. warning:: - The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead, + The debian package that you can currently find in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version or the standalone bundles while we upload the newest packages. First, you need to bootstrap your apt-key:: @@ -44,18 +67,35 @@ And then you can happily install bitmask:: apt-get install bitmask +Distribute & Pip +---------------- + +.. note:: + + The rest of the methods described below in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. For more insight, you can also refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`. + +.. image:: https://pypip.in/v/leap.bitmask/badge.png + :target: https://crate.io/packages/leap.bitmask + + +Installing Bitmask is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions :: + + $ pip install leap.bitmask + + Show me the code! ----------------- +.. XXX UPDATE REPO NAMES AS SOON AS #3417 is DONE + You can get the code from LEAP public git repository :: - $ git clone git://leap.se/bitmask + $ git clone git://leap.se/leap_client Or from the github mirror :: - $ git clone git://github.com/leapcode/bitmask.git + $ git clone git://github.com/leapcode/leap_client.git Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: $ pyton setup.py install - diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 22ad9356..b93df12b 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -6,26 +6,34 @@ Introduction Bitmask ------- .. if yoy change this, change it also in the index.rst -**Bitmask** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon. +**Bitmask** is the multiplatform desktop client for the services offered by :ref:`the LEAP Platform <leapplatform>`. +It is written in python using `PySide`_ and :ref:`licensed under the GPL3 <gpl3>`. +Currently we distribute pre-compiled bundles for Linux and OSX, with Windows +bundles following soon. Features ^^^^^^^^ Bitmask allows to easily secure communications. -- Provider selection -- User registration +- Provider selection. +- User registration. - Encrypted Internet Proxy support (autoconfigured service using openvpn). +- Encrypted email. Coming soon ^^^^^^^^^^^^ -- Encrypted email +- Encrypted chat. + .. _leapplatform: The LEAP Platform ^^^^^^^^^^^^^^^^^ + +.. image:: leap-color-small.* + The LEAP Provider Platform is the server-side part of LEAP that is run by service providers. It consists of a set of complementary packages and recipes to automate the maintenance of LEAP services in a hardened GNU/Linux environment. Our goal is to make it painless for service providers and ISPs to deploy a secure communications platform. Read `more about the LEAP Platform <https://leap.se/en/technology/platform>`_ or `check out the code <https://github.com/leapcode/leap_platform>`_. @@ -97,5 +105,7 @@ Bitmask is released under the terms of the `GNU GPL version 3`_ or later. .. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt +.. _`PySide`: http://qt-project.org/wiki/PySide + .. ??? include whole version? .. include:: ../COPYING diff --git a/docs/user/leap-color-small.png b/docs/user/leap-color-small.png Binary files differnew file mode 100644 index 00000000..bc9d4e7f --- /dev/null +++ b/docs/user/leap-color-small.png diff --git a/docs/user/running.rst b/docs/user/running.rst index da83e9ef..0a93204c 100644 --- a/docs/user/running.rst +++ b/docs/user/running.rst @@ -3,7 +3,8 @@ Running ================== -This document covers how to launch Bitmask. +This document covers how to launch Bitmask. Also know as, where the magic +happens. Launching Bitmask ----------------- @@ -11,7 +12,7 @@ After a successful installation, there should be a launcher called `bitmask` som % bitmask -The first time you launch it, it should launch the first run wizard that will guide you through the setup of the LEAP Services. +The first time you launch it, it should launch the first run wizard that will guide you through the mostly automatic configuration of the LEAP Services. .. note:: @@ -37,8 +38,8 @@ If you ask for it, you can also have all that debug info in a beautiful file rea .. If you want to increment the level of verbosity passed to openvpn, you can do:: .. $ bitmask --openvpn-verbosity 4 -Options ------------- +I want all the options! +----------------------- To see all the available command line options:: $ bitmask --help |
