Arbit - project tracking

Arbit installation guide

This article is a stub, please help us extending it with more detailed information.

This document will help you to set up an arbit instance.

Prerequisite

The minimum prerequisite for installing arbit currently are:

• A webserver with PHP 5.3

  We are not aware of any non default PHP extensions required for arbit. OpenSSL support is required for optional OpenID authentification.

• A running CouchDB instance, with the minimum version 0.8.1

Installation

There are two variants of installation. On a system supporting links, you should probably chose the first one.

Linking

Link the htdocs/ folder from arbit to your webroot itself or a subdirectory in your webroot.

Copying

Copy the complete arbit instance ton one directory above your webroot and configure your webserver to serve the htdocs/ folder from arbit as you webroot.

Some files from the folders above the actual htdocs/ directory, like the cache, config and log files, should not be accessible from the web.

Webserver configuration

There are two ways to configure your webserver to get arbit working. Either configure the index.php as your 404-error-handler, or rewrite all requests, except for the images/, styles/ and scripts/ directories to the index.php.

Arbit may reside inside some subdirectory like http://example.org/arbit/ or directly in the vhost root, like http://example.org. Both should be handled properly by arbit itself.

Apache example configuration

You can configure arbit to either reside in the vhost root, or in some subdirectory. A .htaccess files with the required rewrite rules is provided in the htdocs/ directory. The rewrite rules should look like:

RewriteEngine On

RewriteRule images/.* $0 [L]
RewriteRule styles/.* $0 [L]
RewriteRule scripts/.* $0 [L]
RewriteRule .* index.php [L,QSA]

Everything else should just work like known from apache.

Lighttpd example configuration

A lighttpd example configuration using a 404-error-handler could for example look like:

$HTTP["host"] =~ "^arbit$" {
    var.localroot = vhostbase + "/arbit"
    server.document-root = localroot + "/htdocs/"

    server.error-handler-404 = "/index.php"
}

You may also use rewrite rules with lighttpd, like with apache. The configuration then would look like:

$HTTP["host"] =~ "^arbit$" {
    var.localroot        = vhostbase + "/arbit"
    server.document-root = localroot + "/htdocs/"

    url.rewrite-once = (
        "^/(?:images|styles|scripts)/.*" => "$0",
        "^/.*" => "index.php",
    )
}

If your arbit installation resides in some subdirectory you should modify the rewrite rules accordingly.

Arbit configuration

Arbit configuration is completely done in config/ directory of you checkout. There are two configuration files you are required to edit. The first is the config/main.ini. There you configure the overall used projects and modules. Most of the configuration items should be self descriptive, and all are documented.

For the project you need to create a folder with the identifier of your project, which contains a project.ini with your project configuration. As a template for this configuration file you may copy the project.ini from the example project.

Register first user

All user registrations currently needs to be confirmed by clicking on the confirmation link in the registration email. Those are often not sent out on developer hosts. In this case you can activate accounts manually by following these steps:

1. Open the futon CouchDB admin interface

2. Select the database for the current project, something like "arbit_example", where "example" is the project name

3. Find the user document, which is named something like "user-login", where "login" is your chosen login name.

4. Edit this document

5. Change the value of the "valid" property to the JSON string "1".

6. Clear the model cache, by executing rm -rf var/cache/* in your arbit directory.

Administrators can use the arbit interface to confirm user accounts, which can be found at "The project" -> "Users".