Configuring Annotate

Annotate relies on a configuration file, annotate.conf, for everything that is supposed to be customized by the administrator. To generate an initial configuration, Annotate is shipped with an interactive Perl script. It will ask you a few questions about the most important things to configure and will create a working configuration. You can decide whether you want to configure Annotate for the authoring station, for the web server, or for both.

Note

If authoring station and web server are the same machine, one configuration file is sufficient to configure both parts. Otherwise, two configuration files are needed: one for the authoring part, and one for the web server. For more information on this, please refer to Chapter 3, The annotate.conf configuration file.

So the first thing to do is to run the installation script:

perl install.pl

The script will ask for some configuration details one by one. It will show you the default settings in braces. If a default value is reasonable for your environment, you can simply press Enter, otherwise you should enter the desired value. Having answered every question, you can again review your settings and then create a configuration file in your current directory.

Put this file (annotate.conf) into the /usr/local/etc directory. If you cannot put it there, please refer to the section called “The right place for the configuration file” for details.

The new configuration file will serve as a starting point for your Annotate installation. However, the interactive installation process only sets up Annotate for the most basic operation. Annotate provides many features beyond this. For a complete list of configuration options, please have a look at Chapter 3, The annotate.conf configuration file.