CGIBurn CONFIG - Instructions for configuring CGIBurn, a Web-based CD burning package.
CGIBurn has two configuration files -- a cache and one or more editable configuration files. The cache file is what is actually used by the running server; it is a Perl module stored in CGIBurn::ConfCache.pm. The configuration files are what you edit to change CGIBurn's behavior. The top-level configuration file is cgiburn.conf; you should never need to edit that directly. It includes other files that actually configure CGIBurn.
When you are first installing CGIBurn, you should use smartinstall to install the initial configuration. After that, you can use checkconf to modify the configuration, unless you move CGIBurn to an entirely different location. In that case, you should just save your configuration, and reinstall it, or look at what smartinstall does and make the changes by hand.
You can test and manipulate configuration files with the checkconf script in the tools subdirectory. Type
perldoc checkconf
from the tools directory to see full documentation.
The most useful options are -c dirname to tell checkconf to test the configuration in a particular directory, and -i to tell checkconf to install the configuration you specfied with -c into its cache file.
The two files you will actually need to edit are local.conf and devices.conf. Both are normally located in cgi-data/conf.
There are four types of settings groups -- ``Locations'', ``Settings'', ``Driver'', and ``DriverMap''. A group is started by putting the group name at the beginning of a line, followed by a space and the name for this group for the ``Driver'' and ``DriverMap'' groups. Groups that don't have names can appear multiple times; there is no significance to what options appear in what grouping.
Inside a section, the format of each line is
OptionName: OptionValue
The OptionValue can contain two special values. First, if you put ``$SomeOtherSetting'' somewhere in the string, the value of that setting or location will be substituted. The setting or location must be defined before you can use it as a substitution in an OptionValue. Second, the special string ``/?'' means put exactly one slash there, even if a variable you have substituted contains a slash at the end. For example, whether ``SomeVar'' contains ``dir/'' or just ``dir'', ``$SomeVar/?'' will always evaluate to ``dir/''.
The local configuration file specifies a few configuration options specific to your installation of CGIBurn.
It should contain (in this order) your base options, a line instructing it to install as root or as non-root, a line including an installation template file, and then any settings that you want to override the template file.
At least these settings must be set in local.conf for your installation to function properly.
cgiburn is a good choice.
This setting will be ignored if you aren't installing CGIBurn as root.
If CGIBurn isn't installed as root, this must be a group of which you are a member.
This helper program increases the priority of programs which are actively burning to a CD, since if these programs get bogged down by other processes, your writer will get behind, and your CD will be destroyed.
Setting this option requires you to be installing CGIBurn as root. If there is a serious bug in hipri, or if your system has problems with scripts which are SetUID, this could compromise the security of your system. I'm not aware of any serious bugs in hipri, but nobody's perfect. You've been warned.
If you set this option to yes, only members of the group specified in WebGroup will be allowed to execute it. Putting your Web server in its own group will make this option safer, since only programs run by your Web server will be able to execute it.
Include root.conf
in the configuration file. Otherwise, put
Include nonroot.conf
in.
Include template.conf
where template.conf is the name of the template configuration file you chose.
Static Web pages and images will be installed in the html/$MyName subdirectory; CGI scripts directly accessible by the user in the cgi-bin/$MyName subdirectory; libraries and tools used by CGIBurn in cgi-lib/$MyName; data files used by CGIBurn in cgi-data/$MyName.
Put
Include manydirs.conf
in your config file to do this.
To edit the driver configuration files, cd into the CGIBurn root directory, and edit
cgi-data/conf/devices.conf
This file consists of records describing devices. Here's an example of one:
Device botcd Description: CD in Bottom Drive Type: CDRW Mode: RW Capabilities: 4x 2x 8x ReadLocation: /dev/cdrom1 WriteLocation: 0,1,0 AutoMountLocation: /auto/cdrom1
The individual devices are described by lines which indicate their attributes. A new device is started by putting the word ``Device'' at the beginning of a line, followed by the device's name. Attributes are set within a device by putting the attribute name, then a colon, then the value or values.
You can name devices whatever you want, but names cannot contain spaces. These names are used only internally to the CGI scripts, so it doesn't much matter what you pick, but it should be something that makes sense.
The settings that are recognized are as follows:
CD - Plain CD reader
MusicCD - CD with music on it (NOT YET WORKING)
CDRW - CD burner which supports CDRWs.
CDR - CD burner
dir - A directory to copy files to or from
raw - A file or character-special device file
to copy entire CDs from or to.
CD - Character-special device for CD (/dev/cdrom)
MusicCD - Same as CD
CDRW - [ See ReadLocation, WriteLocation ]
CDR - [ See ReadLocation, WriteLocation ]
dir - Path to directory (make sure permissions allow
Web user to read and write)
raw - Path to file or character-special device (make
sure permissions allow Web user to read and
write)
CDRW - Character-special device for CD (/dev/cdrom1) CDR - Same as CDRW
CDRW - Comma-separated triplet of SCSI-bus,SCSI-target,
SCSI-lun. For example, if your CDR is on your
first SCSI card, its SCSI ID is 4, and it doesn't
have any special LUNs, you would use 0,4,0. See
the manpage for cdrecord for more information on
this parameter; it is passed directly to cdrecord.
Note specifically that under Linux, IDE CDRW
devices are treated as SCSI devices with the
"ide-scsi" driver.
CDR - Same as CDRW.
CD - None.
MusicCD - None.
CDRW - Burning speeds should be included here, simply
written as "2x", "4x", etc. The first speed you
specify will be the default; other speeds are
available from the Advanced Settings option.
CDR - Same as CDRW.
dir - None.
raw - None.
In that case, use LockDevice to indicate what device should be locked instead of this one.
These options are normally set either in your installation template file, or in the file defaults.conf. To override these settings, include a line in the appropriate section (``Locations'' or ``Settings'') after the line including the template (otherwise the template will override your settings).
Items in this section preceded with the word ``Setting'' should appear in a ``Settings'' group; items preceded with the word ``Location'' should appear in a ``Locations'' group.
This setting is ignored if CGIBurn isn't installed as root.
If CGIBurn isn't installed as root, this must be a group of which you are a member.
This setting is ignored if CGIBurn isn't installed as root.
If CGIBurn isn't installed as root, this must be a group of which you are a member.
Your Webserver must recognize this directory as a directory that it serves, and the location here must correspond to the location in HTMLURL.
This directory needs to be writable by processes started by your Webserver, it must recognize this directory as one that it serves, and the location here must correspond to the location in JobURL.
Your Webserver must recognize this directory as a directory that it serves, and the location here must correspond to the location in ImageURL.
Your Webserver must recognize this directory as executable, and the URL configured in CGIURL must correspond to this directory.
This directory needs to be writable by processes started by your Webserver.
This URL should correspond to the directory in HTMLDir.
This URL should correspond to the directory in JobDir.
This URL should correspond to the directory in CGIDir.
This URL should correspond to the directory in ImageDir.
README, checkconf, smartinstall, CGIBurn::Conf, CGIBurn::ConfParse.
$Id: CONFIG.pod,v 402.1 2001/02/05 11:43:37 sgifford Exp $