<commit_before>.. _install:

============
Requirements
============

Docker must be installed.

==========
Installing
==========

Blockade can be installed via ``pip`` or ``easy_install``:

.. code-block:: bash

    $ pip install blockade

Because Blockade executes ``iptables`` and ``tc`` commands, it must
be installed on a Linux system or VM. It must be run as a user that
has an ability to launch Docker containers. Typically this is done
by adding the user to the ``docker`` group.

It is potentially possibly to make Blockade talk to a remote Docker API
but this is not yet supported.


OSX
---

If you are using OSX, Blockade and Docker cannot yet be truly run natively.
Use the included ``Vagrantfile`` or another approach to get Docker and
Blockade installed into a Linux VM. If you have `Vagrant`_ installed, running
``vagrant up`` from the Blockade checkout directory should get you started.
Note that this may take a while, to download needed VMs and Docker containers.

.. _Vagrant: http://www.vagrantup.com<commit_msg>Update install.rst<commit_after>.. _install:

============
Requirements
============

Docker must be installed.

==========
Installing
==========

Blockade can be installed via ``pip`` or ``easy_install``:

.. code-block:: bash

    $ pip install blockade

Because Blockade executes ``iptables`` and ``tc`` commands, it must
be installed on a Linux system or VM. It must be run as a user that
has an ability to launch Docker containers. Typically this is done
by adding the user to the ``docker`` group.

It is potentially possibly to make Blockade talk to a remote Docker API
but this is not yet supported.


OSX or Windows
---

If you are using OSX or Windows, Blockade and Docker cannot yet be truly run natively.
Use the included ``Vagrantfile`` or another approach to get Docker and
Blockade installed into a Linux VM. If you have `Vagrant`_ installed, running
``vagrant up`` from the Blockade checkout directory should get you started.
Note that this may take a while, to download needed VMs and Docker containers.

.. _Vagrant: http://www.vagrantup.com
{'fraction_non_alphanumeric': 0.10664753706360593, 'fraction_numerical': 0.0, 'mean_word_length': 4.269521410579345, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3550526', 'n_tokens_mistral': 587, 'n_tokens_neox': 551, 'n_words': 304}