summaryrefslogtreecommitdiff
path: root/docs/user/install.rst
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2013-09-04 18:39:14 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2013-09-04 18:39:14 -0300
commit2bcff2cf5154af5bf129ced066a014925a5eac0b (patch)
tree00e3018eba9ad359edb273f1b5569d695729251b /docs/user/install.rst
parent9e47e7695e25802f7f0e33deacb940ce72720486 (diff)
parente497e3bd99020f26dcfae3e0fa815179284a8050 (diff)
Merge remote-tracking branch 'kali/feature/update-docs-to-0.3.2' into develop
Diffstat (limited to 'docs/user/install.rst')
-rw-r--r--docs/user/install.rst62
1 files changed, 51 insertions, 11 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
-