NAME

Vipaka - Readme


DESCRIPTION

To get started with vipaka, first edit a config file. For starters, use the basic.conf file. Edit it for the databases you'd like to connect to.

Next set the $VIPAKA_HOME environment variable. This specifies where vipaka will look for the vipaka.conf file (otherwise it will look in the current directory). Also, vipaka will store the .vipaka.pid, and .vipakafifo files here.

Next start vipakad running. You can use the -h option for help, or just start it like this:

$ bin/vipakactl -s -c vipaka.conf


GENERAL INSTRUCTIONS

See the quickstart document for more information about getting started. See the config guide for information on configuration of vipaka in general, and the vipaka.conf file in particular. See the install guide for more info on installation.


FILE DESCRIPTIONS


vipakactl

start, stop, and query a running vipakad daemon. use -h option for help


vipakad

main vipaka utility. You probably won't run this directly.


vipaka.pm

common code for vipakad, vipakactl, and vipakagentd.


basic.conf

This is the simplest of vipaka config files. Edit it to get started.


prefgroups.conf

This config file demonstrates how to use preference groups with vipaka.


vipaka.conf

A well documented fully featured vipaka config file.


doc_root/images

images needed by the html files


doc_root/help

directory containing static html help files


doc_root/info

directory which will contain more info files, giving information about the particular statistic, and it's status.


doc_root/docs

Online html documentation for vipaka.


sql/vipaka_user.sql

auxillary sql script for creating a special read-only ``vipaka'' user to run the tool as.


doc_root

This is the document root where your html files will be generated. If you're going to use vipaka with a webserver, put this in your web doc_root, perhaps naming it vipaka. Use the -k option to vipakactl to specify it's location, or the doc_root directive in your config file.