-<!-- $Id: frontend.xml,v 1.3 2001-07-19 23:29:40 adam Exp $ -->
- <chapter><title id="server">Making an IR Server for Your Database</title>
-
+<!-- $Id: frontend.xml,v 1.29 2006-04-25 11:25:08 marc Exp $ -->
+ <chapter id="server"><title>Generic server</title>
<sect1><title>Introduction</title>
-
+
<para>
If you aren't into documentation, a good way to learn how the
- backend interface works is to look at the <filename>backend.h</filename>
+ back end interface works is to look at the <filename>backend.h</filename>
file. Then, look at the small dummy-server in
- <filename>ztest/ztest.c</filename>. Finally, you can have a look at
- the <filename>seshigh.c</filename> file, which is where most of the
- logic of the frontend server is located. The <filename>backend.h</filename>
+ <filename>ztest/ztest.c</filename>. The <filename>backend.h</filename>
file also makes a good reference, once you've chewed your way through
the prose of this file.
</para>
<para>
If you have a database system that you would like to make available by
- means of Z39.50, &yaz; basically offers your two options. You
+ means of Z39.50, SRW o SRU, &yaz; basically offers your two options. You
can use the APIs provided by the &asn;, &odr;, and &comstack;
modules to
create and decode PDUs, and exchange them with a client.
<para>
The backend interface was designed in anticipation of a specific
integration task, while still attempting to achieve some degree of
- generality. We realise fully that there are points where the
+ generality. We realize fully that there are points where the
interface can be improved significantly. If you have specific
functions or parameters that you think could be useful, send us a
mail (or better, sign on to the mailing list referred to in the
- toplevel README file). We will try to fit good suggestions into future
+ top-level README file). We will try to fit good suggestions into future
releases, to the extent that it can be done without requiring
too many structural changes in existing applications.
</para>
</note>
- </sect1>
- <sect1><title>The Database Frontend</title>
+ <note>
+ <para>
+ The &yaz; server does not support XCQL.
+ </para>
+ </note>
+ </sect1>
+
+ <sect1 id="server.frontend"><title>The Database Frontend</title>
<para>
We refer to this software as a generic database frontend. Your
The backend API consists of a small number of function handlers and
structure definitions. You are required to provide the
<function>main()</function> routine for the server (which can be
- quite simple), as well as a set of handlers to match each of the prototypes.
+ quite simple), as well as a set of handlers to match each of the
+ prototypes.
The interface functions that you write can use any mechanism you like
to communicate with your database system: You might link the whole
thing together with your database application and access it by
<listitem><para>
Extended Services (optional).
</para></listitem>
-
+
<listitem><para>
Result-Set Delete (optional).
</para></listitem>
<listitem><para>
Result-Set Sort (optional).
</para></listitem>
-
+
+ <listitem><para>
+ Return Explain for SRW/SRU (optional).
+ </para></listitem>
+
</itemizedlist>
<para>
</para>
</sect1>
- <sect1><title>The Backend API</title>
+ <sect1 id="server.backend"><title>The Backend API</title>
<para>
- The headers files that you need to use the interface are in the
- <filename>include/yaz</filename> directory. They are called
- <filename>statserv.h</filename> and <filename>backend.h</filename>. They
- will include other files from the <filename>include/yaz</filename>
- directory, so you'll probably want to use the -I option of your
- compiler to tell it where to find the files. When you run
- <literal>make</literal> in the toplevel &yaz; directory,
- everything you need to create your server is put the
- <filename>lib/libyaz.a</filename> library.
+ The header file that you need to use the interface are in the
+ <filename>include/yaz</filename> directory. It's called
+ <filename>backend.h</filename>. It will include other files from
+ the <filename>include/yaz</filename> directory, so you'll
+ probably want to use the -I option of your compiler to tell it
+ where to find the files. When you run
+ <literal>make</literal> in the top-level &yaz; directory,
+ everything you need to create your server is to link with the
+ <filename>lib/libyaz.la</filename> library.
</para>
</sect1>
- <sect1><title>Your main() Routine</title>
+ <sect1 id="server.main"><title>Your main() Routine</title>
<para>
As mentioned, your <function>main()</function> routine can be quite brief.
</para>
<synopsis>
- int statserv_main(int argc, char **argv,
- bend_initresult *(*bend_init)(bend_initrequest *r),
- void (*bend_close)(void *handle));
+int statserv_main(int argc, char **argv,
+ bend_initresult *(*bend_init)(bend_initrequest *r),
+ void (*bend_close)(void *handle));
</synopsis>
<para>
according to the parameters given. When connection requests are received,
the event handler will typically <function>fork()</function> and
create a sub-process to handle a new connection.
- Alternatively the server may be setup to create threads for each connection.
+ Alternatively the server may be setup to create threads for each
+ connection.
If you do use global variables and forking, you should be aware, then,
that these cannot be shared between associations, unless you explicitly
disable forking by command line parameters.
</para>
-
+
<para>
The server provides a mechanism for controlling some of its behavior
without using command-line options. The function
</para>
<synopsis>
- statserv_options_block *statserv_getcontrol(void);
+statserv_options_block *statserv_getcontrol(void);
</synopsis>
<para>
- Will return a pointer to a <literal>struct statserv_options_block</literal>
+ will return a pointer to a <literal>struct statserv_options_block</literal>
describing the current default settings of the server. The structure
contains these elements:
-
+
<variablelist>
- <varlistentry><term>int dynamic</term><listitem><para>
+ <varlistentry><term>
+ <literal>int dynamic</literal></term><listitem><para>
A boolean value, which determines whether the server
will fork on each incoming request (TRUE), or not (FALSE). Default is
TRUE. This flag is only read by UNIX-based servers (WIN32 based servers
doesn't fork).
</para></listitem></varlistentry>
-
- <varlistentry><term>int threads</term><listitem><para>
+
+ <varlistentry><term>
+ <literal>int threads</literal></term><listitem><para>
A boolean value, which determines whether the server
will create a thread on each incoming request (TRUE), or not (FALSE).
- Default is FALSE. This flag is only read by UNIX-based servers that offer
- POSIX Threads support. WIN32-based servers always operate in threaded mode.
+ Default is FALSE. This flag is only read by UNIX-based servers
+ that offer POSIX Threads support.
+ WIN32-based servers always operate in threaded mode.
</para></listitem></varlistentry>
-
- <varlistentry><term>int inetd</term><listitem><para>
+
+ <varlistentry><term>
+ <literal>int inetd</literal></term><listitem><para>
A boolean value, which determines whether the server
will operates under a UNIX INET daemon (inetd). Default is FALSE.
</para></listitem></varlistentry>
-
- <varlistentry><term>int loglevel</term><listitem><para>
+
+ <varlistentry><term>
+ <literal>int loglevel</literal></term><listitem><para>
Set this by ORing the constants defined in
<filename>include/yaz/yaz-log.h</filename>.
</para></listitem></varlistentry>
-
- <varlistentry><term>char logfile[ODR_MAXNAME+1]</term>
+
+ <varlistentry><term>
+ <literal>char logfile[ODR_MAXNAME+1]</literal></term>
<listitem><para>File for diagnostic output ("": stderr).
</para></listitem></varlistentry>
- <varlistentry><term>char apdufile[ODR_MAXNAME+1]</term>
+
+ <varlistentry><term>
+ <literal>char apdufile[ODR_MAXNAME+1]</literal></term>
<listitem><para>
- Name of file for logging incoming and outgoing APDUs ("": don't
- log APDUs, "-": <literal>stderr</literal>).
+ Name of file for logging incoming and outgoing APDUs
+ ("": don't log APDUs, "-":
+ <literal>stderr</literal>).
</para></listitem></varlistentry>
- <varlistentry><term>char default_listen[1024]</term>
+ <varlistentry><term>
+ <literal>char default_listen[1024]</literal></term>
<listitem><para>Same form as the command-line specification of
listener address. "": no default listener address.
Default is to listen at "tcp:@:9999". You can only
specify one default listener address in this fashion.
</para></listitem></varlistentry>
- <varlistentry><term>enum oid_proto default_proto;</term>
- <listitem><para>Either <literal>PROTO_SR</literal> or
- <literal>PROTO_Z3950</literal>. Default is <literal>PROTO_Z39_50</literal>.
+ <varlistentry><term>
+ <literal>enum oid_proto default_proto;</literal></term>
+ <listitem><para>Either <literal>PROTO_Z3950</literal> or
+ <literal>PROTO_SR</literal>.
+ Default is <literal>PROTO_Z39_50</literal>.
</para></listitem></varlistentry>
- <varlistentry><term>int idle_timeout;</term>
- <listitem><para>Maximum session idletime, in minutes. Zero indicates
- no (infinite) timeout. Default is 120 minutes.
+
+ <varlistentry><term>
+ <literal>int idle_timeout;</literal></term>
+ <listitem><para>Maximum session idle-time, in minutes. Zero indicates
+ no (infinite) timeout. Default is 15 minutes.
</para></listitem></varlistentry>
-
- <varlistentry><term>int maxrecordsize;</term>
+
+ <varlistentry><term>
+ <literal>int maxrecordsize;</literal></term>
<listitem><para>Maximum permissible record (message) size. Default
- is 1Mb. This amount of memory will only be allocated if a client requests a
- very large amount of records in one operation (or a big record). Set it
- to a lower number
- if you are worried about resource consumption on your host system.
+ is 1Mb. This amount of memory will only be allocated if a
+ client requests a very large amount of records in one operation
+ (or a big record).
+ Set it to a lower number if you are worried about resource
+ consumption on your host system.
</para></listitem></varlistentry>
- <varlistentry><term>char configname[ODR_MAXNAME+1]</term>
+ <varlistentry><term>
+ <literal>char configname[ODR_MAXNAME+1]</literal></term>
<listitem><para>Passed to the backend when a new connection is received.
</para></listitem></varlistentry>
- <varlistentry><term>char setuid[ODR_MAXNAME+1]</term>
+ <varlistentry><term>
+ <literal>char setuid[ODR_MAXNAME+1]</literal></term>
<listitem><para>Set user id to the user specified, after binding
the listener addresses.
</para></listitem></varlistentry>
-
- <varlistentry>
- <term>void (*bend_start)(struct statserv_options_block *p)</term>
+
+ <varlistentry><term>
+ <literal>void (*bend_start)(struct statserv_options_block *p)</literal>
+ </term>
<listitem><para>Pointer to function which is called after the
command line options have been parsed - but before the server
starts listening.
When the server operates as an NT service this handler is called
whenever the service is started.
</para></listitem></varlistentry>
-
- <varlistentry>
- <term>void (*bend_stop)(struct statserv_options_block *p)</term>
- <listitem><para>Pointer to function which is called whenver the server
+
+ <varlistentry><term>
+ <literal>void (*bend_stop)(struct statserv_options_block *p)</literal>
+ </term>
+ <listitem><para>Pointer to function which is called whenever the server
has stopped listening for incoming connections. This function pointer
has a default value of NULL in which case it isn't called.
When the server operates as an NT service this handler is called
whenever the service is stopped.
</para></listitem></varlistentry>
- <varlistentry><term>void *handle</term>
+ <varlistentry><term>
+ <literal>void *handle</literal></term>
<listitem><para>User defined pointer (default value NULL).
This is a per-server handle that can be used to specify "user-data".
Do not confuse this with the session-handle as returned by bend_init.
a static area. You are allowed to change the contents of the structure,
but the changes will not take effect before you call
</para>
-
+
<synopsis>
- void statserv_setcontrol(statserv_options_block *block);
+void statserv_setcontrol(statserv_options_block *block);
</synopsis>
<note>
</note>
</sect1>
- <sect1><title>The Backend Functions</title>
+ <sect1 id="server.backendfunctions"><title>The Backend Functions</title>
<para>
For each service of the protocol, the backend interface declares one or
<sect2><title>Init</title>
<synopsis>
- bend_initresult (*bend_init)(bend_initrequest *r);
+bend_initresult (*bend_init)(bend_initrequest *r);
</synopsis>
<para>
<function>bend_init</function> handler is passed in the call to
<function>statserv_start</function>.
</para>
+
+ <para>
+ This handler is also called when operating in SRW/SRU mode - when
+ a connection has been made (even though SRW/SRU does not offer
+ this service).
+ </para>
+
<para>
Unlike previous versions of YAZ, the <function>bend_init</function> also
serves as a handler that defines the Z39.50 services that the backend
Z_ReferenceId *referenceId;/* reference ID */
char *peer_name; /* dns host of peer (client) */
+ char *implementation_id;
char *implementation_name;
char *implementation_version;
int (*bend_sort) (void *handle, bend_sort_rr *rr);
int (*bend_delete)(void *handle, bend_delete_rr *rr);
int (*bend_scan)(void *handle, bend_scan_rr *rr);
int (*bend_segment)(void *handle, bend_segment_rr *rr);
+
+ ODR decode; /* decoding stream */
+ /* character set and language negotiation - see include/yaz/z-charneg.h */
+ Z_CharSetandLanguageNegotiation *charneg_request;
+ Z_External *charneg_response;
+ int (*bend_srw_explain)(void *handle, bend_explain_rr *rr);
+ int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
} bend_initrequest;
typedef struct bend_initresult
<para>
The members <literal>peer_name</literal>,
+ <literal>implementation_id</literal>,
<literal>implementation_name</literal> and
- <literal>implementation_version</literal> holds DNS of client, name
+ <literal>implementation_version</literal> holds
+ DNS of client, ID of implementor, name
of client (Z39.50) implementation - and version.
</para>
<sect2><title>Search and retrieve</title>
<para>We now describe the handlers that are required to support search -
- and retrieve. You must support two functions - one for seearch - and one
+ and retrieve. You must support two functions - one for search - and one
for fetch (retrieval of one record). If desirable you can provide a
third handler which is called when a present request is received which
allows you to optimize retrieval of multiple-records.
int hits; /* number of hits */
int errcode; /* 0==OK */
char *errstring; /* system error string or NULL */
+ Z_OtherInformation *search_info;
} bend_search_rr;
-
</synopsis>
<para>
The <function>bend_search</function> handler is a fairly close
- approximation of a protocol Search Request - and Response PDUs
+ approximation of a protocol Z39.50 Search Request - and Response PDUs
The <literal>setname</literal> is the resultSetName from the protocol.
You are required to establish a mapping between the set name and whatever
your backend database likes to use.
corresponding to the resultSetIndicator field in the protocol.
<literal>num_bases/basenames</literal> is a length of/array of character
pointers to the database names provided by the client.
- The <literal>query</literal> is the full query structure as defined in the
- protocol ASN.1 specification.
+ The <literal>query</literal> is the full query structure as defined in
+ the protocol ASN.1 specification.
It can be either of the possible query types, and it's up to you to
determine if you can handle the provided query type.
Rather than reproduce the C interface here, we'll refer you to the
defined error codes, and the suggested uses of the addinfo field.
</para>
+ <para>
+ The <function>bend_search</function> handler is also called when
+ the frontend server receives a SRW/SRU SearchRetrieveRequest.
+ For SRW/SRU, a CQL query is usually provided by the client.
+ The CQL query is available as part of <literal>Z_Query</literal>
+ structure (note that CQL is now part of Z39.50 via an external).
+ To support CQL in existing implementations that only do Type-1,
+ we refer to the CQL-to-PQF tool described
+ <link linkend="tools.cql.pqf">here</link>.
+ </para>
+ <para>
+ To maintain backwards compatibility, the frontend server
+ of yaz always assume that error codes are BIB-1 diagnostics.
+ For SRW/SRU operation, a Bib-1 diagnostic code is mapped to
+ SRW/SRU diagnostic.
+ </para>
+
<synopsis>
int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
int errcode; /* 0==success */
char *errstring; /* system error string or NULL */
int surrogate_flag; /* surrogate diagnostic */
+ char *schema; /* string record schema input/output */
} bend_fetch_rr;
</synopsis>
<para>
The frontend server calls the <function>bend_fetch</function> handler
- when it needs database records to fulfill a Search Request or a Present
- Request.
+ when it needs database records to fulfill a Z39.50 Search Request, a
+ Z39.50 Present Request or a SRW SearchRetrieveRequest.
The <literal>setname</literal> is simply the name of the result set
that holds the reference to the desired record.
The <literal>number</literal> is the offset into the set (with 1
being the first record in the set). The <literal>format</literal> field
- is the record format requested by the client (See section
- <link linkend="oid">Object Identifiers</link>). The value
- <literal>VAL_NONE</literal> indicates that the client did not
- request a specific format. The <literal>stream</literal> argument
+ is the record format requested by the client (See
+ <xref linkend="asn.oid"/>).
+ The value <literal>VAL_NONE</literal> indicates that the client did
+ not request a specific format. The <literal>stream</literal> argument
is an &odr; stream which should be used for
allocating space for structured data records.
The stream will be reset when all records have been assembled, and
the response package has been transmitted.
- For unstructured data, the backend is responsible for maintaining a static
- or dynamic buffer for the record between calls.
+ For unstructured data, the backend is responsible for maintaining a
+ static or dynamic buffer for the record between calls.
+ </para>
+
+ <para>
+ If a SRW/SRU SearchRetrieveRequest is received by the frontend server,
+ the <literal>referenceId</literal> is NULL and the
+ <literal>request_format</literal> (transfer syntax) is XML (OID name
+ <literal>VAL_TEXT_XML</literal>).
+ The schema for SRW/SRU is stored in both the
+ <literal>Z_RecordComposition</literal>
+ structure and <literal>schema</literal> (simple string).
</para>
<para>
database that holds the
record. <literal>len</literal> is the length of the record returned, in
bytes, and <literal>record</literal> is a pointer to the record.
- <literal>Last_in_set</literal> should be nonzero only if the record
+ <literal>last_in_set</literal> should be nonzero only if the record
returned is the last one in the given result set.
<literal>errcode</literal> and <literal>errstring</literal>, if
given, will be interpreted as a global error pertaining to the
oid_value format; /* One of the CLASS_RECSYN members */
Z_ReferenceId *referenceId;/* reference ID */
Z_RecordComposition *comp; /* Formatting instructions */
- ODR stream; /* encoding stream - memory source if required */
+ ODR stream; /* encoding stream */
ODR print; /* printing stream */
bend_request request;
bend_association association;
<para>
The <function>bend_present</function> handler is called when
- the server receives a Present Request. The <literal>setname</literal>,
+ the server receives a Z39.50 Present Request.
+ The <literal>setname</literal>,
<literal>start</literal> and <literal>number</literal> is the
name of the result set - start position - and number of records to
be retrieved respectively. <literal>format</literal> and
<sect2><title>Delete</title>
<para>
- For backends that supports delete of a result set only one handler
+ For back-ends that supports delete of a result set only one handler
must be defined.
</para>
<note>
<para>
- The delete set function definition is rather primitive, mostly because we
- have had no practical need for it as of yet. If someone wants
+ The delete set function definition is rather primitive, mostly because
+ we have had no practical need for it as of yet. If someone wants
to provide a full delete service, we'd be happy to add the
extra parameters that are required. Are there clients out there
that will actually delete sets they no longer need?
} bend_scan_status;
typedef struct bend_scan_rr {
- int num_bases; /* number of elements in databaselist */
+ int num_bases; /* number of elements in database list */
char **basenames; /* databases to search */
oid_value attributeset;
Z_ReferenceId *referenceId; /* reference ID */
bend_scan_status status;
int errcode;
char *errstring;
+ char *scanClause; /* CQL scan clause */
} bend_scan_rr;
</synopsis>
+ <para>
+ This backend server handles both Z39.50 scan
+ and SRW/SRU scan. In order for a
+ handler to distinguish between SRW/SRU (CQL) scan
+ Z39.50 Scan , it must check for a non-NULL value of
+ <literal>scanClause</literal>.
+ </para>
+ <note>
+ <para>
+ if designed today, it would be a choice using a union or similar,
+ but that would break binary compatibility with existing servers.
+ </para>
+ </note>
</sect2>
</sect1>
- <sect1><title>Application Invocation</title>
+ <sect1 id="server.invocation"><title>Application Invocation</title>
<para>
The finished application has the following
invocation syntax (by way of <function>statserv_main()</function>):
</para>
- <synopsis>
- <replaceable>appname</replaceable> [-szSiTu -a <replaceable>apdufile</replaceable> -l <replaceable>logfile</replaceable> -v <replaceable>loglevel</replaceable> -c <replaceable>config</replaceable>]
- [listener ...]
- </synopsis>
-
+ &gfs-synopsis;
+
<para>
- The options are
-
- <variablelist>
-
- <varlistentry><term>-a <replaceable>file</replaceable></term>
- <listitem><para>
- Specify a file for dumping PDUs (for diagnostic purposes).
- The special name "-" sends output to
- <literal>stderr</literal>.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-S</term>
- <listitem><para>
- Don't fork or make threads on connection requests. This is good for
- debugging, but not recommended for real operation: Although the
- server is asynchronous and non-blocking, it can be nice to keep
- a software malfunction (okay then, a crash) from affecting all
- current users.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-T</term>
- <listitem><para>
- Operate the server in threaded mode. The server creates a thread
- for each connection rather than a fork a process. Only available
- on UNIX systems that offers POSIX threads.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-s</term>
- <listitem><para>
- Use the SR protocol (obsolete).
- </para></listitem></varlistentry>
-
- <varlistentry><term>-z</term>
- <listitem><para>
- Use the Z39.50 protocol (default). These two options complement
- each other. You can use both multiple times on the same command
- line, between listener-specifications (see below). This way, you
- can set up the server to listen for connections in both protocols
- concurrently, on different local ports.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-l <replaceable>file</replaceable></term>
- <listitem><para>The logfile.
- </para></listitem></varlistentry>
+ The options are:
- <varlistentry><term>-c <replaceable>config</replaceable></term>
- <listitem><para>A user option that serves as a specifier for some
- sort of configuration, e.g. a filename.
- The argument to this option is transferred to member
- <literal>configname</literal>of the
- <literal>statserv_options_block</literal>.
- </para></listitem></varlistentry>
+ &gfs-options;
- <varlistentry><term>-v <replaceable>level</replaceable></term>
- <listitem><para>
- The log level. Use a comma-separated list of members of the set
- {fatal,debug,warn,log,all,none}.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-u <replaceable>userid</replaceable></term>
- <listitem><para>
- Set user ID. Sets the real UID of the server process to that of the
- given user. It's useful if you aren't comfortable with having the
- server run as root, but you need to start it as such to bind a
- privileged port.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-w <replaceable>dir</replaceable></term>
- <listitem><para>
- Working directory.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-i</term>
- <listitem><para>
- Use this when running from the <application>inetd</application> server.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-t <replaceable>minutes</replaceable></term>
- <listitem><para>
- Idle session timeout, in minutes.
- </para></listitem></varlistentry>
-
- <varlistentry><term>-k <replaceable>size</replaceable></term>
- <listitem><para>
- Maximum record size/message size, in kilobytes.
- </para></listitem></varlistentry>
-
- </variablelist>
</para>
-
+
<para>
A listener specification consists of a transport mode followed by a
colon (:) followed by a listener address. The transport mode is
- either <literal>osi</literal> or <literal>tcp</literal>.
+ either <literal>tcp</literal>, <literal>unix:</literal> or
+ <literal>ssl</literal>.
</para>
-
+
<para>
- For TCP, an address has the form
+ For TCP and SSL, an address has the form
</para>
<synopsis>
hostname | IP-number [: portnumber]
</synopsis>
-
+
<para>
The port number defaults to 210 (standard Z39.50 port).
</para>
<para>
- For osi, the address form is
- </para>
-
- <synopsis>
- [t-selector /] hostname | IP-number [: portnumber]
- </synopsis>
-
- <para>
- The transport selector is given as a string of hex digits (with an even
- number of digits). The default port number is 102 (RFC1006 port).
- </para>
-
- <para>
- Examples
- </para>
-
- <screen>
- tcp:dranet.dra.com
-
- osi:0402/dbserver.osiworld.com:3000
- </screen>
-
- <para>
- In both cases, the special hostname "@" is mapped to
- the address INADDR_ANY, which causes the server to listen on any local
- interface. To start the server listening on the registered ports for
- Z39.50 and SR over OSI/RFC1006, and to drop root privileges once the
- ports are bound, execute the server like this (from a root shell):
+ For UNIX, the address is the filename of socket.
</para>
- <screen>
- my-server -u daemon tcp:@ -s osi:@
- </screen>
-
<para>
- You can replace <literal>daemon</literal> with another user, eg. your
- own account, or a dedicated IR server account.
- <literal>my-server</literal> should be the name of your
- server application. You can test the procedure with the
- <application>yaz-ztest</application> application.
+ For TCP/IP and SSL, the special hostname <literal>@</literal>
+ (at sign) is mapped to the address <literal>INADDR_ANY</literal>,
+ which causes the server to listen on any local interface.
</para>
+ <example><title>Running the GFS on Unix</title>
+ <para>
+ Assuming the server application <replaceable>appname</replaceable> is
+ started as root, the following will make it listen on port 210.
+ The server will change identity to <literal>nobody</literal>
+ and write its log to <filename>/var/log/app.log</filename>.
+ <screen>
+ <replaceable>appname</replaceable> -l /var/log/app.log -u nobody tcp:@:210
+ </screen>
+ </para>
+ <para>
+ The server will accept Z39.50 requests and offer SRW/SRU service
+ on port 210.
+ </para>
+ </example>
+ <example><title>Setting up Apache as SRW/SRU Frontend</title>
+ <para>
+ If you use <ulink url="&url.apache;">Apache</ulink>
+ as your public web server and want to offer HTTP port 80
+ access to the YAZ server on 210, you can use the
+ <ulink url="&url.apache.directive.proxypass;">
+ <literal>ProxyPass</literal></ulink>
+ directive.
+ If you have virtual host
+ <literal>srw.mydomain</literal> you can use the following directives
+ in Apache's httpd.conf:
+ <screen>
+ <VirtualHost *>
+ ErrorLog /home/srw/logs/error_log
+ TransferLog /home/srw/logs/access_log
+ ProxyPass / http://srw.mydomain:210/
+ </VirtualHost>
+ </screen>
+ </para>
+ <para>
+ The above for the Apache 1.3 series.
+ </para>
+ </example>
+ <example><title>Running a server with local access only</title>
+ <para>
+ Servers that is only being accessed from the local host should listen
+ on UNIX file socket rather than a Internet socket. To listen on
+ <filename>/tmp/mysocket</filename> start the server as follows:
+ <screen>
+ <replaceable>appname</replaceable> tcp:/tmp/mysocket
+ </screen>
+ </para>
+ </example>
+ </sect1>
+ <sect1 id="server.vhosts"><title>Virtual Hosts</title>
+ &gfs-virtual;
</sect1>
</chapter>
-
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document: "yaz.xml"
- sgml-local-catalogs: "../../docbook/docbook.cat"
+ sgml-local-catalogs: nil
sgml-namecase-general:t
End:
-->
projects / yaz-moved-to-github.git / blobdiff