Koha/debian/docs/koha-start-sip.xml
Robin Sheat 3dc22e7fb2 Bug 9250 - [SIGNED-OFF] provide commands to manage the SIP server
This adds commands required to control the SIP server. These commands
are:
* koha-enable-sip - copies the SIP config to the sites directory
* koha-start-sip - starts the SIP server processes
* koha-stop-sip - stops the SIP server processes

It also calls these as appropriate from the koha-common init script.

To use:
1) sudo koha-enable-sip instancename
2) sudo vim /etc/koha/sites/instancename/SIPconfig.xml
   Do whatever is needed for your site's SIP configuration
3) sudo koha-start-sip instancename

To test:
1) Build packages with this patch
2) Ensure that sudo koha-start-sip instancename doesn't do anything
3) Run sudo koha-enable-sip instancename
4) Edit /etc/koha/sites/instancename/SIPconfig.xml if needed (probably
   not required for testing)
5) Run sudo koha-start-sip instancename
6) Note that the sip processes are now running
7) Run sudo koha-stop-sip instancename
8) Note that the sip processes have gone
9) Reboot your Koha server
10) Note that the sip processes are back

Sponsored-By: Waitaki District Council Libraries
Sponsored-By: South Taranaki District Council Libraries
Sponsored-By: Horowhenua District Council Libraries
Sponsored-By: Rangitikei District Council Libraries

Signed-off-by: Magnus Enger <magnus@enger.priv.no>
Works as advertised. koha-start-sip without a prior koha-enable-sip
does nothing. koha-enable-sip copies the SIP config file to the
instance directory. After koha-enable-sip, koha-start-sip and
koha-stop-sip works as expected. After a reboot, the SIP processes are
still running. I have not actually tested the SIP servers after they
have been started, but assume they work the same as always.
The man pages look good.

The new commands should also have been added to the man page for
koha-common. I'll do a followup for that.
Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
2013-05-01 22:03:13 -04:00

53 lines
1.7 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-start-sip</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<personname>
<firstname>Robin</firstname>
<surname>Sheat</surname>
</personname>
<affiliation>
<orgname>Catalyst IT</orgname>
<uri>http://www.catalyst.net.nz</uri>
</affiliation>
<contrib>Author</contrib>
</author>
</info>
<refentry xml:id="koha-start-sip">
<refmeta>
<refentrytitle>koha-start-sip</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-start-sip</refname>
<refpurpose>Starts the SIP daemon for the specified Koha instances.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-start-sip</command>
<arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>This will start the SIP daemon for the Koha instance specified by <arg>instancename</arg>.</para>
<para>If the SIP configuration is not present for the supplied instance, it will be silently skipped.</para>
<para>To enable SIP support for an instance, refer to <command>koha-enable-sip(8)</command>.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-stop-sip(8)</command></member>
<member><command>koha-enable-sip(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>