Porcupine Installation

Installing Porcupine on a target OS with Python installed is straightforward. Just download the latest release's source zip file unpack it and you are almost ready to go. Please note that the latest release requires Pyhton 2.5 or later but not supporting Pyhton 3.x yet.

Due to the fact that the bsddb module is deprecated since Python 2.6, you may also need to download and compile BerkeleyDB and the bsddb module itself.

The BerkeleyDB library can be found at: http://www.oracle.com/database/berkeley-db/

The Python bsddb module: http://www.jcea.es/programacion/pybsddb.htm

Unlike previous versions of Porcupine the latest version (v0.6) does not include the database files, therefore the database needs to be intialized. On the other hand if the source zip file includes the database files, there is a slight possibility of not being able to run Porcupine due to incompatible versions of Berkeley DB. In this case remove all the files inside the "store" directory and re-initialize the database.

In order to initialize the database type:

$ python ./db_init.py

If the installation machine is Windows based but has no Python installed then instead you may download the win32 installer, that includes the Python runtime along with the required dependencies, but it does not include all of the Python libraries. Using the installer you can select some configuration parameters such as the database directory, the ports that the server is listening and whether to install Porcupine as an NT service or not.

 

Running Porcupine in a console window

In order to run Porcupine in a console window, simply run:

$ python ./porcupineserver.py

To stop the Porcupine services hit CRTL+C.

 

Running Porcupine as a daemon

On Linux and MacOS based machines you can start Porcupine as a daemon by typing:

$ python ./porcupineserver.py daemon

To stop the daemon type:

$ python ./porcupineserver.py stop

 

Running Porcupine as an NT service

On Windows you can install Porcupine as an NT service (assuming that you have downloaded the source code and having installed the Python for Windows extensions) by typing:

$ python porcupinesvc.py install

Include the "auto" switch if you wish the service to be automatically started during the system's startup. To start the service type:

$ python porcupinesvc.py start

To stop it:

$ python porcupinesvc.py stop

 

Documentation

• Administrator's Guide
  • • Porcupine Installation
    • Web Connector Installa...
• Upgrading Porcupine
• Changelog