From 1782f6328de41a19dfa8e81f30b9fe31c1a0d34c Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 21:37:25 +0200 Subject: Images shuffle --- docs/user/leap-color-small.png | Bin 0 -> 10100 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/user/leap-color-small.png (limited to 'docs/user') diff --git a/docs/user/leap-color-small.png b/docs/user/leap-color-small.png new file mode 100644 index 00000000..bc9d4e7f Binary files /dev/null and b/docs/user/leap-color-small.png differ -- cgit v1.2.3 From 1fd9b7cffaf1063c3a2a23e056556be18ef3848a Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 21:38:02 +0200 Subject: Update intro --- docs/user/intro.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'docs/user') 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 ` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform `. 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 `. +It is written in python using `PySide`_ and :ref:`licensed under the 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 `_ or `check out the code `_. @@ -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 -- cgit v1.2.3 From 9d4c219cdfc331286f6650fd746c75fcd3e0ce35 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Wed, 4 Sep 2013 16:55:37 -0300 Subject: Add install:bundle section. --- docs/user/install.rst | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) (limited to 'docs/user') diff --git a/docs/user/install.rst b/docs/user/install.rst index da1d914c..2a597c8b 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -8,24 +8,51 @@ We assume that you want to get it properly installed before being able to use it .. 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 ` or :ref:`fetching latest code for testing `. + 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 ` or :ref:`fetching latest code for testing `. +Standalone bundle +----------------- + +You can run Bitmask using the standalone bundle, the recommended way to use Bitmask. + +For the latest bundles and its signatures in https://downloads.leap.se/client/ + +Linux 32 bits: + https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2 + + https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2.asc + +Linux 64 bits: + https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2 + + https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2.asc + +OSX: + https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg + + https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg.asc + +Windows version is delayed right now. + +For the signature verification you can use :: + + $ gpg --verify Bitmask-linux64-0.3.1.tar.bz2.asc + +Asuming that you downloaded the linux 64 bits bundle. Distribute & Pip ---------------- -.. 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. - Installing Bitmask is as simple as using `pip `_ for the already released versions :: - $ pip install bitmask + $ pip install leap.bitmask 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 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. First, you need to bootstrap your apt-key:: -- cgit v1.2.3 From f00463b3dd05d7c060d91d1d6898b1a704090662 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:00:42 +0200 Subject: Reformat links to downloads with symlinks --- docs/user/install.rst | 62 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 26 deletions(-) (limited to 'docs/user') diff --git a/docs/user/install.rst b/docs/user/install.rst index 2a597c8b..37a1713e 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -6,53 +6,50 @@ 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. -.. note:: - - 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 ` or :ref:`fetching latest code for testing `. - Standalone bundle ----------------- -You can run Bitmask using the standalone bundle, the recommended way to use Bitmask. +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. -For the latest bundles and its signatures in https://downloads.leap.se/client/ +You can get the latest bundles, and their matching signatures at `the downloads page `_. -Linux 32 bits: - https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2 +Linux +^^^^^ +- `Linux 32 bits bundle`_ (`signature `_) +- `Linux 64 bits bundle`_ (`signature `_) - https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2.asc +OSX +^^^ +- `OSX bundle`_ (`signature `_) -Linux 64 bits: - https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2 - - https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2.asc - -OSX: - https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg +Windows +^^^^^^^ +.. note:: - https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg.asc + The release of the bundles for Windows is delayed right now. We should resume + producing them shortly, keep tuned. -Windows version is delayed right now. +Signature verification +^^^^^^^^^^^^^^^^^^^^^^ For the signature verification you can use :: - $ gpg --verify Bitmask-linux64-0.3.1.tar.bz2.asc + $ gpg --verify Bitmask-linux64-latest.tar.bz2.asc Asuming that you downloaded the linux 64 bits bundle. -Distribute & Pip ----------------- - -Installing Bitmask is as simple as using `pip `_ for the already released versions :: - - $ pip install leap.bitmask +.. _`PySide`: http://qt-project.org/wiki/PySide +.. _`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/osx/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:: @@ -71,6 +68,19 @@ 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 ` or :ref:`fetching latest code for testing `. + + +Installing Bitmask is as simple as using `pip `_ for the already released versions :: + + $ pip install leap.bitmask + + Show me the code! ----------------- -- cgit v1.2.3 From e50ff1f5b82f004b3a38cdc366aa021a7e987c23 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:07:16 +0200 Subject: Revert repo names for the moment --- docs/user/install.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/user') diff --git a/docs/user/install.rst b/docs/user/install.rst index 37a1713e..d6354dab 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -4,7 +4,7 @@ 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 ----------------- @@ -38,11 +38,10 @@ For the signature verification you can use :: Asuming that you downloaded the linux 64 bits bundle. -.. _`PySide`: http://qt-project.org/wiki/PySide .. _`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/osx/Bitmask-windows-latest.zip +.. _`Windows bundle`: https://downloads.leap.se/client/windows/Bitmask-windows-latest.zip Debian package -------------- @@ -84,15 +83,16 @@ Installing Bitmask is as simple as using `pip `_ 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 - -- cgit v1.2.3 From c33094f4216b4ef21f25bf448904839d8d50a2f0 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:15:11 +0200 Subject: Minor additions --- docs/user/running.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'docs/user') 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 -- cgit v1.2.3 From 261de005c0a2ecbc8ef4a7771cfeb2a853cbc00d Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:18:23 +0200 Subject: Add pypi version icon in user/install --- docs/user/install.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/user') diff --git a/docs/user/install.rst b/docs/user/install.rst index d6354dab..b5fb7810 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -74,6 +74,9 @@ Distribute & Pip 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 ` or :ref:`fetching latest code for testing `. +.. image:: https://pypip.in/v/leap.bitmask/badge.png + :target: https://crate.io/packages/leap.bitmask + Installing Bitmask is as simple as using `pip `_ for the already released versions :: -- cgit v1.2.3