ADMINISTRATION 2.45 KB
Newer Older
Per Cederqvist's avatar
Per Cederqvist committed
1 2
		     Administrating a LysKOM site
		     ============================
Per Cederqvist's avatar
Per Cederqvist committed
3
			   For lyskomd 1.6
Per Cederqvist's avatar
Per Cederqvist committed
4 5 6 7 8 9 10 11 12 13 14

  This document is a short description of how to administrate a LysKOM
database on your site.

  The first thing you will have to do is to follow the instructions in
the file INSTALL.  This will set up the LysKOM system with a database
containing a few necessary conferences and one person - the
administrator.

  Once the LysKOM system is running, there is not much you will have
to do to keep it that way.  One thing to remember is that the current
Per Cederqvist's avatar
Per Cederqvist committed
15 16
release of the server has an incomplete handling of garbage collection
of the database.  The database is split into two files, the
Per Cederqvist's avatar
Per Cederqvist committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
information file and the text file.  Newly written texts are
concatenated to the text file and old texts are never removed.  The
information file contains information about conferences, users and
where in the text file the texts are.  This file is properly garbage
collected, but not the text file.

  There is a program called dbck (Data Base Check) which is used to
check the consistency of the LysKOM database.  This program can also
be used to shrink the text file.  To do this, just type `dbck -g' in
the database directory, or give additional switches to dbck to use the
correct directory.  See further the manual page for dbck.  When dbck
is to be run on the database, the LysKOM server *must* be stopped, or
unrepairable damage may result.  See below for a description on how to
stop the server.

Per Cederqvist's avatar
Per Cederqvist committed
32
  There is a shell script called updateLysKOM which is used to ensure
Per Cederqvist's avatar
Per Cederqvist committed
33 34 35
continuous operation.  This script is run with certain intervals and
if the LysKOM server has died for some reason, updateLysKOM restarts
it.  If the server is still running properly, updateLysKOM sends a
Per Cederqvist's avatar
Per Cederqvist committed
36
signal (SIGUSR1) to it, which causes the server to write some
Per Cederqvist's avatar
Per Cederqvist committed
37 38 39 40 41 42 43 44
statistics to a file named etc/lyskomd-log in the lyskom directory.

  Taking the server down cleanly can be done in two ways: through the
use of the LysKOM protocol on a socket, preferably through the use of
a suitable client, or to send the signal SIGHUP to it.  This will
cause the server to save the database and close all client
connections.  It will also create a file named etc/memory-usage in
which the memory usage of the server is reported.  There is currently
Per Cederqvist's avatar
Per Cederqvist committed
45 46 47 48
a small memory leak in the server (typically, less than 10 memory
blocks leaks per server run).  We know about it, so there is no need
to send bug reports to us about that (unless you have found where the
leak is).