API:bin/indexer

From EPrints Documentation
Revision as of 15:27, 16 December 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

indexer - Indexing daemon for EPrints

User Comments


SYNOPSIS

indexer start [options]

indexer stop

indexer status

indexer install

indexer uninstall

indexer --help

User Comments


DESCRIPTION

This daemon runs in the background and creates index files for all eprints repositories.

Messages and errors are logged to /opt/eprints3/var/indexer.log unless you change the log options. If it appears to be having problems try raising the log level and examining the log.

Once every 24 hours, the indexer rolls the logs (up to logfile.5) and then starts again. See --rollcount for ways to customise this.

User Comments


OPTIONS

User Comments


--help

Print a brief help message and exit.

User Comments


--man

Print the full manual page and then exit.

User Comments


--quiet

Be vewwy vewwy quiet. This option will supress all output unless an error occurs.

User Comments


--force

Start up, even if the PID file exists (implying another copy is running). This is useful for starting after a crash, but be carefully not to run to copies at once as BAD THINGS will happen.

User Comments


--verbose

Explain in detail what is going on. May be repeated for greater effect.

User Comments


--clear

Clear broken event queue items (items that are "inprogress" or "failed") before commencing.

User Comments


--retry

Retry broken event queue items (items that are "inprogress" or "failed") before commencing.

User Comments


--logfile filename

Log to filename rather than default indexer log.

User Comments


--loglevel level

Set the level of detail to log. Level may be 0-6.

User Comments


--rollcount number

Set the number of once-through logs that should be kept. If set to zero then indexer will never roll the logs but rather just keep writing to the main log.

User Comments


--respawn seconds

Respawn the indexer every seconds (rolls the log files).

User Comments


--notdaemon

Do not become a daemon, remain attached to the current terminal.

Log goes to STDERR instead of the log file.

Does not create a .pid file.

User Comments


--once

Only clear the current queue of things needing indexing then exit.

User Comments


--version

Output version information and exit.

User Comments


Making into a service

This has only been tested under redhat linux. It make work on other OS's, but not promise.

To make the indexer into a service which starts and stops on reboots etc. like httpd and mysqld do the following (as root):

ln -s /opt/eprints3/bin/epindexer /etc/init.d/epindexer 
chkconfig --add epindexer
chkconfig epindexer on
 

The epindexer script runs as root, changes user to "eprints" (or whatever uid your eprints install runs as) and then calls indexer.


User Comments


COPYRIGHT

User Comments