:LastChangedDate: $LastChangedDate$
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

.. _install:


Installation
============

Here you can find instructions for developers and advanced users. For **user
instructions**, you should refer to the official `Bitmask Install Guide`_. You
should only need to read the following sections if:

* You plan to contribute code to bitmask core libraries.
* You intend to develop the Bitmask JS User Interface.
* You are a prospective maintainer for some platform yet unsupported.
* Your platform is unsupported by the official packages, and you want to
  install the python packages in your system.

If you want to contribute translations to some of these sections, please get in
touch with us, it will be greatly appreciated to extend the community.

.. _`Bitmask Install Guide`: https://bitmask.net/en/install

.. _pip:

With Pip
--------

If we still do not provide packages for your platform (debian/ubuntu only at
the moment), and for some reason you cannot run the `bundles we offer for
download`_, you still should be able to run bitmask downloading the packages from
pypi. First you will need some dependencies in your system, that very probably
will be provided by your package manager::

  lxpolkit openvpn gnupg1 python-pyqt5 python-dev libffi-dev

Now you can install the latest bitmask package from pypi::

  pip install leap.bitmask[gui]

If you want also to use the pixelated MUA, you need to install an additional extra::

  pip install leap.bitmask[pixelated]

.. _`bundles we offer for download`: https://bitmask.net/install


From git
--------

If you want to run latest code from git, you can refer to the :ref:`setting up
the development environment <devenv>` section to learn how to run Bitmask from
the latest code in the master branch.

Building bundles
----------------

The standalone bundles are built with PyInstaller.

If you are inside a development virtualenv, you should be able to install it
together with some extra development dependencies with::

  pip install -r pkg/requirements-dev.pip

And then just do::

  make bundle

To build a new bundle.

There's also a script that automates re-creating the virtualenv from which the
packaging takes place:: 
  
  pkg/build_bundle_with_venv.sh

To ensure a repeatable system-wide environment, you can build those bundles from
within a docker container. First you need to create the container::

  make bundler_image

and then you can launch the above script inside that container::

  make bundle_in_docker

That will build the latest from master. If you're interested in building some
development branch, you can pass some extra variables::

  make bundle_in_docker REPO=https://0xacab.org/kali/bitmask-dev BRANCH=somethingcool

A new bundle is created by the CI for every commit using this procedure
involving docker, you can read more about the bundles in the :ref:`qa section
<qa>`.

Debian & ubuntu 
---------------

You only need to paste three lines to get bitmask installed under debian or
ubuntu, and get updates as they are released, or as they are merged into
master. `Watch a screencast`_ of the install process.

Refer to the section in the install guide about the different `debian
repositories`_ that we provide to understand how the different packages are
produced.

The debian packages are maintained in the ``debian/`` folder in the source code repo.

For a quick rebuild of local changes, you can do::

  debuild -us -uc

.. _`Watch a screencast`: https://asciinema.org/a/Hfg0Z5k95j4JfF0S31B7SCrZ8
.. _`debian repositories`: https://bitmask.net/install/linux/debs


Archlinux
---------

Not officially supported, but DoctorJellyFace maintains a PKGBUILD that can be found in the `AUR`_ repo.

.. _`AUR`: https://aur.archlinux.org/packages/bitmask_client/