How do I install OSHIP on MacOSX?

Created by Roberto Siqueira on
install installation Mac MacOSX
Last updated by:
Tim Cook on

These instructions are out of date. OSHIP now requires Python 2.6.x Please see the installation instructions at:

We have tested these steps on MacOSX 10.3 "Panther" and MacOSX 10.4 "Tiger".
As everything is installed through the MacPorts packaging system (, the same procedure should work on other MacOSX flavors as well.
We would appreciate some feedback if you find any issues with them.

The MacPorts framework depends on 2 optional components: X11 and Xcode, that can be found inside your "Mac OS X Install DVD". If they are not already present on your system, start by launching this DVD and installing them.

You can now download and install MacPorts, following the instructions given here: .

OSHIP requires Python 2.5. Regardless whether your MacOSX comes with Python 2.5 pre-installed or not, MacPorts' python25 package should be installed next, as it is a nonconflicting version (confined to the "/opt/local" directory) that is fully compatible with the other packages that OSHIP will need, later on. Open a new "Terminal" and type:

sudo port install python25

The virtualenv package allows us to create python-sandboxes, which are isolated development environments. This will prevent various versions of libraries or packages to interfere with each other:

sudo port install py25-virtualenv

Before we move on by creating our first sandbox, make sure to have bazaar available, which is used to keep track of the different versions of the source code and accompanying files:

sudo port install bzr

Now, we create a sandbox with a Python interpreter that is different from the system-wide interpreter. A directory called `oshipenv` will be created. We prefer to create this under the users' home directory since we will end up with some pretty deep directory structure:

virtualenv-2.5 --no-site-packages oshipenv

Creating the sandbox is not enough, we also need to activate it (note how the prompt gets prefixed with the name of the sandbox in parentheses):

cd oshipenv
source bin/activate

If you do not have a Launchpad login use:

bzr checkout lp:oship main

to obtain the code for OSHIP. Continue with step 8).

If you _do_ have a Launchpad account (ahoy, OSHIP developer!):

Obtain the latest stable OSHIP source tree: type "bzr branch lp:~oship-mgmt/oship/stable"

This latter form of the bzr command will allow you to create your own branch or commit back to the project.

OSHIP was built using a lot of open source basis code. Prepare for some time to wait as we obtain that code:

cd main/oship

If you are a developer and are going to perform multiple installations, there is some time to gain here. See the FAQ
"How do I speed up subsequent installations?" (

We are almost there. Assuming that port 8080 is available for the web server to handle requests, start up the server:

bin/oship-ctl fg

In a web browser, go to http://localhost:8080
Login with the defaults:
user = admin
password = admin

NOTE: We can execute bin/zpasswd to change these defaults and select the encryption method later.

We arrive at the <add application page>;
type 'oship' (without quotes) into the box and click the

Then, click on the oship (oship) link.
We will now arrive at OSHIP's Main Management Screen with the address http://localhost:8080/oship.

The remaining instructions are there.