Installation

There are currently two ways of installing DocBlox; either via PEAR of manually by downloading and unpacking.
[toc="2,3" title=Table of Contents]

Requirements

Before diving into the installation instructions it is important to know what the requirements are for running DocBlox.
I have tried to make the application accessible for a wide audience and the following is necessary:

• PHP 5.2.6 or higher.
• iconv/ext, the iconv extension is used to make sure DocBlox can handle any character encoding. PHP installs this by default.
• xsl/ext, the XSL extension for PHP is necessary to generate HTML output.
• PEAR & GraphViz, needed for generating Graphs.

Please note that xsl/ext is only required when actually creating the HTML output using the XSL ‘Writer’ (which the default template does) and GraphViz is only required when generating diagrams using the Graph ‘Writer’. Any of these actions can be disabled by adding a new template or editing an existing.

Note: If you do not want to install the PEAR or Graphviz dependency you are encouraged to generate your own template and make sure that it does not contain anything related to `Graph`.
An easier solution might be to edit `data/themes/default/template.xml` file and remove every line containing the word `Graph` but this will be undone with every upgrade of DocBlox.

Please see the documentation about creating your own templates for more information.

PEAR

By far the easiest method of installation is using PEAR. DocBlox has its own PEAR channel located at http://pear.docblox-project.org.
Please open the URL above in your browser for a detailed list of instructions how to set up your PEAR installation and install DocBlox.

Please note that you need to discover 2 additional channels in order to install DocBlox; you can do this with the following command:

$ pear channel-discover pear.zfcampus.org
$ pear channel-discover pear.michelf.com


Manually

PEAR is a great medium but sometimes you just want ‘the’ cutting edge, or you just do not have access to PEAR. In that case this is your way to go!
I will try to describe the process as clearly as possible in a step-by-step fashion (though it is really simple).

1. Choose whether you want the cutting edge version or a packaged version; the cutting edge version contains by far the most recent features and changes but might contain some bugs (though I try to prevent those ) or known issues, where as the packaged version is stable and has most (if not all) known issues resolved.
2. Download the tarball of your chosen version; in the sidebar you can find download links with which you can download the version that you’d like.
3. Unzip to a location on your hard drive
4. Make DocBlox available from any location on your computer:
   1. LINUX / MAC: Create a symbolic link from your /usr/bin directory to the [project folder]/bin/docblox.php
   2. WINDOWS: Add the [project folder]/bin folder to your environment path
5. Have fun! You have just installed DocBlox. Easy is it, not?