summaryrefslogtreecommitdiff
path: root/README.md
blob: 8864866c842aa4fe168e502e38390e6e856d7e90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
leap_mx
=======

**Note:** Currently in development. Feel free to test, and please [report bugs](mailto:isis@leap.se).

An asynchronous, transparently-encrypting remailer for the LEAP platform, using BigCouch/CouchDB and PGP/GnuPG, written in Twisted Python.

## [install](#install) ##                 {#install}
=========================

**tl;dr:** To get started quickly do:

 # pip install -r requirements.txt

Although, **it is advised** to install inside a python virtualenv. To install python, virtualenv, and get started, do:

~~~
$ sudo apt-get install python2.7 python-pip virtualenv
$ pip install virtualenvwrapper
$ cd
$ git clone https://github.com/isislovecruft/leap_mx.git leap_mx
$ export WORKON_LEAPMX=~/leap_mx
$ source /usr/local/bin/virtualenvwrapper.sh
$ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/requirements.txt \
      --no-site-packages --setuptools --unzip-setuptools leap_mx
~~~

## [running](#running) ##               {#running}
=========================

Hold your horses, boy. This isn't ready yet -- check back later!