Installing FastFrame Applications

A list of other available applications can be found on the applications page.

Obtaining an Application

You can obtain the latest version of an application, in either .tar.gz format or .zip format, from: http://www.codejanitor.com/download/fastframe

Bleeding-edge development versions of FastFrame and its applications are available via SVN at http://svn.codejanitor.com/

Prerequisites

  1. A working FastFrame installation. All applications require FastFrame, a set of libraries written in PHP, to be installed on your webserver. Instructions on setting up FastFrame are located here.

Unpacking the Code

Each application is written in PHP, and must be installed inside the apps/ directory which is at the top level of your FastFrame installation.

For example, with the FastFrame installed in /usr/local/apache/htdocs/FastFrame, you would type:

cd /usr/local/apache/htdocs/FastFrame/apps
tar zxvf /path/to/application-X.X.tar.gz

If you downloaded the application in .zip format then you would do the following:

cd /usr/local/apache/htdocs/FastFrame/apps
unzip /path/to/application-X.X.zip

Configuring the Application

Registering your Application

In the apps.php file, which is located inside FastFrame’s config/ directory, find the $apps[’application_name’] stanza. The status parameter must be changed to enabled. More on the apps.php file can be found here.

Creating the Config Files

To configure the application, change to the config/ directory of the application, and make copies of all of the configuration “dist” files without the “dist” suffix:

cd config/
for foo in *.dist; do cp $foo `basename $foo .dist`; done

Or if you are installing the application on a Windows system:

cd config
copy *.dist *.

Editing the Config Files

The conf.php file

This file contains all the configurable settings for the application. Each setting is explained and the defaults are sensible, so you only need to edit it if you want to customize the application.

The menu.php file

This file is what makes the application show up in the hierarchical menu on the left-hand side of the window. By editing it, you can add additional links, change who can see the link, and change the icon for a link.

The quicklinks.php file

This file causes a set of links to always be present in the upper-right hand corner of an application for easy accessibility. Not all applications have it, and it does not generally need to be changed.

Creating the Database Tables

You will need to set up the database tables for the application. Below is an example of how to set up the database tables (assuming you created a fastframe database and fastframe MySQL user, as per the database instructions:

cd /path/to/FastFrame/apps/application_name/scripts/db
mysql --user=fastframe --password=<MySQL-fastframe-password> fastframe < mysql_create.sql

The Scripts Directory

Each application contains a scripts/ directory. This directory contains the db/ directory for setting up the database tables, but often several other user-contributed scripts as well to enhance functionality of an application or make it easy to do something (such as importing data from an external source).

 
installing_applications.txt · Last modified: 2005/07/07 14:52 by jrust
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki