diff --git a/modules/webhelp/web/admin/howto/run.html.wml b/modules/webhelp/web/admin/howto/run.html.wml index ff9ccb576..bc9c1a38d 100644 --- a/modules/webhelp/web/admin/howto/run.html.wml +++ b/modules/webhelp/web/admin/howto/run.html.wml @@ -1,155 +1,156 @@ ## $Id$ ## This file is part of the CERN Document Server Software (CDSware). ## Copyright (C) 2002 CERN. ## ## The CDSware is free software; you can redistribute it and/or ## modify it under the terms of the GNU General Public License as ## published by the Free Software Foundation; either version 2 of the ## License, or (at your option) any later version. ## ## The CDSware is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with CDSware; if not, write to the Free Software Foundation, Inc., ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. #include "cdspage.wml" \ title="HOWTO Run Your CDSware Installation" \ navbar_name="admin" \ navtrail_previous_links="/admin/>Admin Area > /admin/howto/>Admin HOWTOs" \ navbar_select="howto_run" Version <: print generate_pretty_revision_date_string('$Id$'); :>
This HOWTO guide intends to give you ideas on how to run your CDSware installation and how to take care of its normal operation day by day.
Many tasks that manipulate the bibliographic record database can be set to run in a periodical mode. For example, we want to have the indexing engine to scan periodically for newly arrived documents to index them as soon as they enter into the system. It is the role of the BibSched system to take care of the task scheduling and the task execution.
Periodical tasks (such as regular metadata indexing) as well as one-time tasks (such as a batch upload of acquired metadata file) are not executed straight away but are stored in the BibSched task queue. BibSched daemon looks periodically in the queue and launches the tasks according to their order or the date of programmed runtime. You can consider BibSched to be a kind of cron daemon for bibliographic tasks.
This means that after CDSware installation you want to have BibSched daemon running permanently. To launch BibSched daemon, do:
To setup indexing, reformatting, and collection updating daemons to run periodically with a sleeping period of, say, 1 hour:$ bibsched -d
HINT: It is good to have these three tasks permanently in your BibSched queue so that your newly submitted documents will be further processed automatically.$ bibindex -s1h $ bibreformat -oHB,HD -s1h $ webcoll -s1h -v0 + $ bibrank -s1h
Note that the BibSched daemon automatic mode stops as soon as some of the tasks ends with an error. It it therefore a good idea to inspect BibSched queue from time to time. This can be done by running the BibSched command-line admin interface:
that will permit you to stop/start the daemon mode, to delete the tasks already submitted, to run some of the tasks manually, etc. Note also that BibSched daemon writes log and error files on its operation and on the operation of its tasks. The log and error files can be found on your system at$ bibsched
HINT: You may want to launch the
bibsched
command from time to time (say a couple of times
per day) to inspect the BibSched queue and to verify the status of the
BibSched system.
Guest users create a lot of entries in BibSched creates log and err files in BibReformat creates temorary XML files in
FIXME: Thoughts on WebSubmit log archives, what to keep, what not.
HINT: You may want to launch this command every day.
In the future the garbage collection task may be done via BibSched task
queue.
$ sessiongc
Alert Engine
HINT: You may want to set up an external cron job
to call
$ alertengine
alertengine
each day.
Cleaning Up the Filesystem
<prefix>/var/log
directory that is good to clean up from time to time. For example:
$ find /usr/local/cdsware-DEMO/var/log -name "bibsched_task_*" -size 0c -exec \rm -f {} \;
$ find /usr/local/cdsware-DEMO/var/log -name "bibsched_task_*" -atime +28 -exec \rm -f {} \;
$ find /usr/local/cdsware-DEMO/var/log -name "bibsched_task_*" -atime +7 -exec gzip -9 {} \;
that may be deleted after they are
uploaded. For example:
$ find /usr/local/cdsware-DEMO/var/tmp -name "rec_fmt_*.xml" -size 0c -exec \rm -f {} \;
$ find /usr/local/cdsware-DEMO/var/tmp -name "rec_fmt_*.xml" -atime +28 -exec \rm -f {} \;
$ find /usr/local/cdsware-DEMO/var/tmp -name "rec_fmt_*.xml" -atime +7 -exec gzip -9 {} \;