Setting up ClueMapper

Installation

Note: Please be sure to check out the prerequisites listed below in the OS tips section

There are three known working ways to deploy ClueMapper currently. All of which are encouraged to using one of the KGS's (known-good-set's).

  1. Install using the buildout (please note that this installs the latest 0.8.x release)

i) Checkout buildout from svn (check out the buildout trunk for bleeding edge code)

    $ svn co http://www.cluemapper.org/svn/buildout/kgs/0.8 cm-buildout

ii). Go into the checked out directory and run the bootstrap

    $ cd cm-buildout
    $ python2.5 bootstrap.py

iii) Next run the buildout itself

    $ ./bin/buildout

iv) Start up cluemapper

    $ ./bin/clue-server
  1. Install using virtualenv (please note that this installs the latest stable release)

i) Download and extract virtualenv

ii) From virtualenv directory, run the following

    $ python2.5 virtualenv.py ../cluemapper

iii) Go into the new virtualenv and easy_install cluemapper

    $ cd ../cluemapper
    $ ./bin/easy_install -i http://dist.serverzen.com/cluemapper/latest/simple/ ClueMapper 

iv) Start up cluemapper

    $ ./bin/clue-server
  1. Install into system Python

i) Make sure easy_install is installed

ii) Run easy_install to install latest ClueMapper

    $ easy_install -i http://dist.serverzen.com/cluemapper/latest/simple/ ClueMapper 

iii) Start up cluemapper

    $ clue-server

Setting up First Admin User

Run addmanager admin command:

    $ cd cm-buildout
    $ ./bin/clue-admin addmanager
    Username:
    Password:
    Confirm Password:

OS-Specific Tips

For your platform of choice make sure these items are installed:

  • Python development libs and headers
  • libxslt development libs and headers
  • sqlite3 development libs and headers
  • python subversion bindings (ones that come with svn)

Ubuntu

Pre-Installation Prerequisites

The following ubuntu packages need to be installed in order for the build process to work:

  • python-devel
  • libxslt1-dev
  • libsqlite3-dev

Post-Installation Requirements

The following ubuntu packages need to be installed in order for the ClueMapper to work:

  • python-subversion

Apache Tips

  • The preferred integration for apache is to use mod_rewrite. Here's a sample conf snippet:
    <VirtualHost *:80>
        ServerName projects.serverzen.com
    
        RewriteEngine On
        RewriteRule  ^/(.*)$ http://127.0.0.1:8080/$1 [L,P]
    </VirtualHost>
    
  • An example for setting up your svn, try:
    <VirtualHost *:80>
        ServerName svn.serverzen.com
        <Location />
           DAV svn
           SVNParentPath /usr/misc/svn/repos
    
           AuthzSVNAccessFile /path/to/svn/authz.acl
           Satisfy Any
           Require valid-user
           AuthType Basic
           AuthName "Subversion repository"
           AuthUserFile /path/to/users.passwd
        </Location>
    </VirtualHost>