diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 93 |
1 files changed, 33 insertions, 60 deletions
@@ -1,83 +1,56 @@ -leap_mx +Leap MX ======= -**Note:** Currently in development. Feel free to test, and please [report - bugs on our tracker](https://we.riseup.net/leap/mx) or [by email](mailto:isis@leap.se). + +**Note:** Currently in development. Feel free to test, and please [report bugs +on our tracker](https://we.riseup.net/leap/mx) or [by +email](mailto:discuss@leap.se). An asynchronous, transparently-encrypting remailer for the LEAP platform, using BigCouch/CouchDB and PGP/GnuPG, written in Twisted Python. -## [install](#install) ## +## Installing -### [virtualenv](#virtualenv) ### -================================= -Impatient? Don't like virtualenvs? [tl;dr](#tl;dr) + * Leap MX is available as a debian package in [Leap + repository](http://deb.leap.se/repository/). + * A python package is available in + [pypi](https://pypi.python.org/pypi/leap.mx). Use ./pkg/requirements.pip + to install requirements. + * Source code is available in [github](https://github.com/leapcode/leap_mx). -Virtualenv is somewhat equivalent to fakeroot for python packages, and -- due -to being packaged with copies of pip and python -- can be used to bootstrap -its own install process, allowing pip and python to be used with sudo. +## Configuring -#### installing without sudo #### +A sample config file can be found in pkg/mx.conf.sample -To install without using sudo, a bootstrap script to handle the setup process -is provided. It does the following: +## Running - 1. Download, over SSL, the latest tarballs for virtualenv and - virtualenvwrapper from pypi. - 2. Unpack the tarballs, use the system python interpreter to call the - virtualenv.py script to setup a bootstrap virtual environment. - 3. Use the pip installed in the bootstrap virtualenv to install - virtualenvwrapper in the bootstrap virtualenv. - 4. Obtain a copy of leap_mx with git clone. - 5. Use ```mkvirtualenv``` included in the virtualenvwrapper inside the - bootstrap virtualenv to install a project virtualenv for leap_mx. +The debian package contains an initscript for the service. If you want to run +from source or from the python package, maybe setup a virtualenv and do: -To use the bootstrap script, do: ~~~ -$ wget -O bootstrap https://raw.github.com/isislovecruft/leap_mx/fix/no-suid-for-virtualenv/bootstrap -$ ./bootstrap -$ workon leap_mx +# git clone or unzip the python package, change into the dir, and do: +$ python setup.py install +# copy ./pkg/mx.conf.sample to /etc/leap/mx.conf and edit that file, then run: +$ twistd -ny pkg/mx.tac ~~~ -#### installing in a regular virtualenv ### -To install python, virtualenv, and get started, do: +## Hacking -~~~ -$ sudo apt-get install python2.7 python-dev python-virtualenv virtualenvwrapper -$ git clone https://github.com/leapcode/leap_mx.git leap_mx -$ export WORKON_LEAPMX=${PWD}/leap_mx -$ source /usr/local/bin/virtualenvwrapper.sh -$ mkvirtualenv -a $WORKON_LEAPMX -r ${WORKON_LEAPMX}/pkg/requirements.pip \ - --no-site-packages --setuptools --unzip-setuptools leap_mx -~~~ +Please see the doc/DESIGN docs. -### [tl;dr](#tl;dr) ### -To get started quickly, without virtualenv, do: -~~~ -$ sudo apt-get install python git -$ git clone https://github.com/leapcode/leap_mx.git -# pip install -r ./leap_mx/pkg/requirements.pip -~~~ -Although, **it is advised** to install inside a python virtualenv. +Our bugtracker is [here](https://leap.se/code/projects/mx). -## [configuration](#configuration) ## -A sample config file can be found in pkg/mx.conf.sample +Please use that for bug reports and feature requests instead of github's +tracker. We're using github for code commenting and review between +collaborators. -## [running](#running) ## -========================= +## Issues -To get running, clone this repo, and (assuming you've already set up your -virtualenv and obtained all the requirements) do: +* see the [Changelog](./CHANGELOG) for details of all major changes in the different versions -~~~ -$ twistd -ny mx.tac -~~~ +### 0.6.1 -## [hacking](#hacking) ## -========================= -Please see the HACKING and DESIGN docs. +* Bouncing messages can get into a bouncing loop (#6858) -Our bugtracker is [here](https://leap.se/code/projects/eip/issue/new). +### 0.6.0 -Please use that for bug reports and feature requests instead of github's -tracker. We're using github for code commenting and review between -collaborators. +* leap-mx needs to get restarted after the first incoming mail is delivered (#6687) |