greenstone.org greenstone wiki greenstone trac planet greenstone

Important Files

From GreenstoneWiki

Contents

Configuration, mapping, log and database files

Greenstone2

GSDLHOME is the main gsdl or greenstone directory.

Configuration files

Server Configuration files

main.cfg 
The main configuration file for the library. Includes things like activation of certain features (administration, collector, depositor, gliapplet, logging), the list of macro files to be used, the list of languages provided, customized default settings for cgi arguments.
lives in GSDLHOME/etc
gsdlsite.cfg 
lives either with library (or library.exe), generally in GSDLHOME/cgi-bin (for a web library) or in the same directory as server.exe (for Windows local library server)
oai.cfg 
OAI server configuration file
lives in GSDLHOME/etc

GLI configuration files

config.xml 
Configuration file for local GLI - stores settings such as library address, last collection open, warnings activated or deactivated etc.
On linux, lives in <USERHOME>/.gli, On Windows, lives in C:\Documents and Settings\<username>\Application Data\Greenstone\GLI
configRemote.xml 
Separate version for use with GLI client. Basically the same os the local version, but includes gliserver address. Needed so that you can run a local GLI at the same time as running GLI with a remote library server.
On linux, lives in <USERHOME>/.gli, On Windows, lives in C:\Documents and Settings\<username>\Application Data\Greenstone\GLI

Collection configuration files

*.col 
GLI configuration file specific to a collection. Includes information about whether the colleciton has been previously imported or built, and stores the import and build options specified in the Create panel for that collection.
lives in a collection's top level directory (GSDLHOME/collect/<collname>/<collname>.col)
collect.cfg 
Collection design file. Can be edited by hand, or is automatically generated by the GLI
lives in a collection's etc directory (GSDLHOME/collect/<collname>/etc)
build.cfg 
Generated automatically by collection building process. Includes build statistics, and information about indexes that have been built.
lives in a collection's index directory (GSDLHOME/collect/<collname>/index)

Mapping files

dc2marc-mapping.xml 
Maps Dublin Core to MARC field numbers
lives in GSDLHOME/etc
qdc2marc-mapping.xml 
Maps Qualified Dublin Core to MARC field numbers
lives in GSDLHOME/etc
marctodc.txt 
used by MARCPlug for mapping MARC field numbers to Greenstone-style metadata.
lives in GSDLHOME/etc

Database files

history.db 
stores search history information if this has been enabled (on preferences page)
lives in GSDLHOME/etc
users.db 
stores any user account settings generated by the administration facility. These accounts are used by the GLI client and GLI applet.
lives in GSDLHOME/etc
key.db 
stores random keys for users. Used in authenticaion and collector/depositor?? Not sure about this.
lives in GSDLHOME/etc

Log files

usage.txt 
log of all commands sent to the library - only generated if logging is enabled in main.cfg (set logcgiargs to true)
lives in GSDLHOME/etc
error.txt 
log of errors that occurred in the run time library
lives in GSDLHOME/etc

Greenstone3

GSDL3HOME is the main greenstone3 directory. GSDL3WEBHOME is, by default, the GSDL3HOME/web directory, but this may be moved to somewhere else.

Configuration files

Server Configuration files

global.properties 
Some global settings for the server, including gsdl3webhome, proxy information, and library urls.
lives in GSDL3WEBHOME/WEB-INF/classes
siteConfig.xml 
Configuration file for a site. Contains info such as site-wide services, soap connections to other servers. Replacement rules for text and metadata (used for macro replacement for greenstone 2 collections)
lives in GSDL3WEBHOME/sites/<site-name>
interfaceConfig.xml 
Configuration file for an interface. Contains info such as
lives in GSDL3WEBHOME/interfaces/<interface-name>
OAIConfig.xml 
the configuration file for the OAI server
lives in GSDL3WEBHOME/WEB-INF/classes

GLI Configuration files

config3.xml 
Greenstone3 equivalent of config.xml
config3Remote.xml 
Greenstone3 equivalent of configRemote.xml

Collection configuration files

collectConfig.xml 
Collection design file. Greenstone3 equivalent to collect.cfg. Can be edited by hand, or is automatically generated by the GLI
lives in a collection's etc directory (GSDL3HOME/collect/<collname>/etc)
buildConfig.xml 
Generated automatically by collection building process. Greenstone3 equivalent to build.cfg. Includes build statistics, and information about indexes that have been built.
lives in a collection's index directory (GSDL3HOME/collect/<collname>/index)

Admin Configuration files =

build.xml 
Ant build file for compilation, installation and running Greenstone3.
lives in GSDL3HOME
build.properties 
Some properties for ccompilation and installation of Greenstone3.
lives in GSDL3HOME
log4j.properties 
settings for the runtime logging
lives in GSDL3WEBHOME/WEB-INF/classes

Log files

greenstone.log 
lives in GSDL3WEBHOME/logs
server.log 
usage.log