Installation on Ubuntu

This section will lead you through installing Project HQ on Ubuntu Linux.

1. Installing Required Software

Ubuntu 8.04 to 9.10 do not have the latest packages for Project HQ, so you will need to install them using EasyInstall. Before we dive into that, however, we will set up a virtual environment for Project HQ and it's associated libraries.

Install Setuptools (which includes EasyInstall) [all versions of Ubuntu]:

@:~$ sudo aptitude install python-setuptools

Install Pylons, SQLAlchemy, chardet and virtualenv [Ubuntu 10.04]:

@:~$ sudo aptitude install python-pylons python-sqlalchemy \
python-chardet python-virtualenv

Install virtualenv [Ubuntu 8.04 - 9.10]:

@:~$ sudo easy_install virtualenv

Create a directory for Project HQ to "live" in [all versions of Ubuntu]:

@:~$ mkdir projecthq

Alternately, create a new user for Project HQ [all versions of Ubuntu]:

@:~$ adduser projecthq

In Project HQ's directory, add the following directories [all versions of Ubuntu]:

@:~$ mkdir etc
@:~$ mkdir data
@:~$ mkdir files
@:~$ mkdir logs

Make the data directory writeable:

@:~$ chmod a+w data

Create a virtual environment [all versions of Ubuntu]:

@:~$ virtualenv venv

Activate the virtual environment [all versions of Ubuntu]:

@:~$ source venv/bin/activate

You will know your virtual environment is active by your prompt:

(venv) @:~$

Install Pylons, SQLAlchemy, chardet [Ubuntu 8.04 - 9.10]:

(venv) @:~$ easy_install Pylons==0.9.7
(venv) @:~$ easy_install SQLAlchemy==0.5.8
(venv) @:~$ easy_install chardet

Install TurboMail [all versions of Ubuntu]:

(venv) @:~$ easy_install TurboMail==3.0.3

Install PasteScript into the virtual environment [Ubuntu 10.04]:

(venv) @:~$ easy_install PasteScript

If you are going to be using Python 2.4, you'll need to install hashlib:

(venv) @:~$ easy_install hashlib

You should now be ready to install Project HQ itself.

2. Installing Project HQ

First download the pre-packaged egg file from the download page. Grab the file that ends with "-py2.6" for Python 2.6, and the file that ends with "-py2.5" for the Python 2.5 and 2.4.

(venv) @:~$ wget https://sourceforge.net/.../ProjectHQ-0.1.3dev_r149-py2.6.egg

Then install it into the virtual environment:

(venv) @:~$ easy_install ProjectHQ-0.1.3dev_r149-py2.6.egg

Once you've installed the egg, you need to set up an instance of Project HQ. Navigate to the "etc" directory you created earlier. Now create a configuration file for yourself:

(venv) @:~$ paster make-config projecthq config.ini

Initial Configuration

One last thing we need to do is perform an initial configuration. Edit the config.ini file, and change the following line:

cache_dir = /path/to/projecthq/data
uploads.dir = /path/to/projecthq/files

Now we can set up the web server.

Project HQ