Table of Contents
Editing the Configuration File
In order to standardise configuration across all platforms, as well as make the software installation mobile (i.e. it is not required to write to system registries on individual workstations), Pergamon desktop software utilises a single configuration file which is used to 'bootstrap' the ability to talk to the central database - the main source of configuration details.
This configuration file does not normally need to be touched after installation, but special configurations, such as running the same software installation across many workstations in a full-network installation, may require minor editing based upon the local environment.
Location
The configuration file is located in:
[Pergamon] > [Application Folder] > System > Configuration > pergamon.cnf
Where [Pergamon] is your main Esferico Pergamon installation folder (common for all Esferico Pergamon applications), and [Application Folder] is the sub-folder named after the version of software that you have installed (e.g. PergamonMu).
The file is a simple text file and should only be edited using text-editing software (i.e. not a word-processor).
Note: While a word-processor can be used to edit the file, it is essential that when it is saved back to the original folder that it is saved ONLY as a normal text file. This often requires the file to be exported rather than simply saved.
File Content
Each section of the file is clearly commented.
Directories
The list of directory parameters contains the locations where certain files should be saved / located. A standard Pergamon installation utilises macros (surrounded by curled-braces) to indicate that these directories should normally be calculated based upon the base installation directory of Pergamon.
A Pipe-symbol (vertical bar) is used to indicate folder separations in order to remain OS neutral.
- DIRHELP - Where the core help files can be found.
- DIRREPORTS - Where the dynamic reporting scripts can be found.
- DIRATTACH - Where record attachments should be saved (e.g. in Readers or the Catalogue).
- DIRPLUGINS - Where the plugin directory structure pattern can be found.
As long as the Pergamon installation folder is moved / installed consistently, these directory locations should never need modifying as the macros ensure that they are always calculated based upon the core installation folder.
If however, the decision is made to move locations of component parts (e.g. the attachments directory) to centralised locations rather than workstations, the entry will need to be modified to reflect the new location.
Other Defaults
Three values currently exist in the Other Defaults section.
- LANG - The default language to use on startup of the workstation. This may be modified dynamically once a reader has logged into the system.
- APPLEVEL - The default application level of the software installation (e.g. PRIMARY indicates the Pergamon MU software). This may be dynamically modified once the system license has been read.
- THEME - The default theme of the Pergamon OPAC splash screen. This may be dynamically modified once the database has been read.
SQLite Database Configuration
The existence of these values is dependant upon the use of a SQLite database.
- DBPATH - The location of the database.
- DBDATABASE - The base name of the database file, without the file extension.
- DBTYPE - The type of database in use - SQLITE
- DBENCRYPT - A flag indicating whether the database is encrypted.
PostgreSQL Database Configuration
The existence of these values is dependant upon the use of a PostgreSQL database.
- DBHOST - The name of the Host server on which the PostgreSQL database is located.
- DBUSER - The name of the PostgreSQL 'role' (i.e. user account) that has been configured for database access.
- DBDATABASE - The name of the database container within PostgreSQL that contains the Pergamon database.
- DBPORT - The port number supporting PostgreSQL connections (always 5432 unless modified).
- DBTYPE - The type of database in use - POSTGRESQL
MySQL Database Configuration
The existence of these values is dependant upon the use of a MySQL database.
- DBHOST - The name of the Host server on which the MySQL database is located.
- DBUSER - The name of the MySQL user that has been configured for database access.
- DBDATABASE - The name of the database container within MySQL that contains the Pergamon database.
- DBPORT - The port number supporting MySQL connections (always 3306 unless modified).
- DBTYPE - The type of database in use - MYSQL
