Installation Instructions

You can use the Modlule Detector at http://recipants-installation-url/util/test-moduldes.cgi to help figure out which modules installed and which are missing.

This will create a tree that looks a lot like this:

.cgi and .pl files - The program files
recipants.cfg.pl   - Program configuration file
static/            - Holds static Web content: CSS & exports
sql/               - SQL scripts
templates/         - Template root, each language has a
                     subdirectory here named by its language code
                     (e.g. 'en')
util/              - Utilities

Create a database and database user for ReciPants. See your database's documentation for instructions.

Load the DB schema and reference data:

• Go to the sql directory.
• Execute the appropriate tables SQL script for your database (e.g. tables-postgres.sql for Postgres, tables-mysql.sql for MySQL, tables-oracle.sql for Oracle). This will create all the database objects that ReciPants needs.
• Execute the ref_data.sql SQL script. This will create the reference data that ReciPants needs, including the admin user account.

You can either use an SMTP server or talk directly to a local copy of sendmail.

In either case, in order for ReciPants to be able to send email as a user other than the owner of the scripts without a warning, it will likely be necessary to do some configuration. For sendmail, you will probably have to include said owner in the trusted-users file (likely /etc/mail/trusted-users). It is likely that you will need root access to do this.

Open the file recipants.cfg.pl in your favorite editor and have at it - the directions are in the file.

For your conveneince, there's a backup of the file called recipants.cfg.pl.DIST with all the default values that you can make use of if your copy gets fubard.

Because this file contains all the information necessary to connect to your database, it is strongly suggested that you move this file out of your Web server's document root to prevent anyone from downloading it. If you do so, you'll have to edit the file librecipants.pl—look for the line that says require "recipants.cfg.pl"; and change it to the right location.

Failing that, ScriptAlias-ing your ReciPants directory is probably a good idea—that way, if someone requests the file, the Web server should try to execute it (which won't produce anything meaningful) instead of just sending the file.

ReciPants comes with one user called "admin" that has "All Access" privileges (the equivalent of root in *nix-land) who can do anything in the system.

Log in to ReciPants. Username admin, password change_me. CHANGE THE PASSWORD IMMEDIATELY!

The password it ships with is the same for everybody, so if you don't change it, anyone can log with the admin account and do whatever they want in your ReciPants system. This is probably Not The Desired Effect(tm). Don't Say I Didn't Warn Ya(tm).

To change the admin password, fire up your ReciPants installation in your Web browser, sign in to the admin account, click the ever-so-surprisingly named "Change My Password" link, and follow the directions.