Skip to content
Upi Tamminen edited this page Nov 1, 2018 · 3 revisions

Kippo needs a number of python packages to run. Best way to install these is by using pip.

To avoid having to deal with incompatibilities with older library versions, this is now the recommended method of setting up kippo.

1. Install the required OS packages

Debian:

$ sudo apt-get install build-essential python-dev libmysqlclient-dev python-virtualenv python-pip

On other operating systems, do something similar until you have the required libraries, as well as a working virtualenv and pip!

No commands after this should be run as root!

2. Setup virtualenv

First, create a new virtualenv called "env":

$ virtualenv env

Activate the newly created virtualenv:

$ . ./env/bin/activate

Your shell prompt will now display the currently active virtualenv:

(env)$

For more information on virtualenv, see https://pypi.python.org/pypi/virtualenv/1.7.1.2

3. Install the required python packages

(env)$ pip install twisted==15.1.0

15.1.0 is the last twisted version that kippo works with

(env)$ pip install pyasn1

(env)$ pip install pycrypto

Additional packages you may need for specific features:

(env)$ pip install MySQL-python

After this is all done, you may choose too deactivate the virtualenv for now:

(env)$ deactivate

4. Prepare kippo

Create kippo.cfg by using kippo.cfg.dist as a template.

5. Run kippo

Starting kippo in foreground:

Activate the virtualenv we created before:

$ . ./env/bin/activate

(env)$ twistd -n -y kippo.tac

Starting kippo in background:

The supplied start.sh shell script takes virtualenv as an optional first argument, and will do the virtualenv activation for you.

Once you have properly setup virtualenv called "env", you can start kippo in the background using the following command:

(env)$ ./start.sh env

6. Ready!