How to Install

Now that our initial release is out we cant be without an installation document, so here is a simple installation procedure for Echofish.

Prerequisites

  • Apache web server (1.x tested, but should work with 2.x as well)
  • PHP5
  • Smarty 2.x (Smarty 3.x also works but there is a warning about assign by ref)
  • PHP pdo_mysql
  • PHP mbstring
  • MySQL Database

OpenBSD Preparation

In order for your OpenBSD system to run Echofish you need to install the following packages.

php5-pdo_mysql
mysql-server
smarty

Installation

Extract the archive you have downloaded

tar zxvf echofish-v0.1a.tgz

This will create a folder named echofish-v0.1a into your system.

Open the file "www/includes/config.php" and change the parameters to whatever fits your setup.

define('DBHOST','localhost');
define('DBUSER','');
define('DBPASS','');
define('DBNAME','echofish');

Now that your configuration file is ready you need to create the databases and required data for Echofish.

First create a dummy database with the same name as the one defined on DBNAME

mysqladmin create echofish

Change folder (this is required) into contrib and run the generate.php

cd echofish/contrib
php generate.php

This will drop the dummy database, re-create it, along with the tables required.

Now we need to add some initial data into our system. To do that, we need to use the populate.php script from within the contrib folder. This will populate the users, groups and languages needed for the system to operate.

php populate.php

Now move the extracted folder to /var/www/echofish or some other name you like and create a symbolic link from the echofish/www/htdocs to your own document root.

mv echofish-v0.1a /var/www/echofish
ln -sf ../echofish/www/htdocs /var/www/htdocs/echofish

If all went well then you are ready to visit the project's page and start using Echofish. The default username/password for the system is “sysadmin”. Login and change the password.

Syslog configuration

In order to start logging into the system you need a syslog capable of either producing correct (escaped) MySQL INSERT queries, or a syslog with direct access to your MySQL database.

The contrib/syslog-ng folder holds some examles of how you can use syslog-ng with SQL escaping and pipe writing.

If you use the example config for syslog-ng make sure you change the table from syslog to archive.

Designed by Klou