Koha/debian/docs/koha-remove.xml
Jared Camins-Esakov 297d22459f Bug 6913: More options for koha-create and koha-remove
This commit makes koha-create more flexible by adding a number of command-line
and configuration options.

The biggest change is to add support for pre-determined MySQL credentials using
a file in /etc/koha/passwd (for security reasons, if you use this feature, make
sure the file is not world-readable). The configuration file has the following
format:
instance:user:password:database
The database is optional, but the other two are both required if you want to
specify MySQL credentials. If no credentials are specified for a given instance,
the standard koha_instance username and an auto-generated password are used.

The following additional command line options are now available:
* --use-db - use a pre-existing database, see also --database
* --database - specify the name of the mysql database (still defaults to
  koha_instance)
* --passwdfile - specify a custom (Koha) passwd file for MySQL credentials

The following additional variables are now available (for use in
koha-sites.conf or a custom config file):
* OPACPORT (previously added but not documented) - port on which the OPAC
  should be served
* OPACPREFIX - prefix for the OPAC's virtual host
* OPACSUFFIX - suffix for the OPAC's virtual host

This commit also adds the --keep-mysql option to koha-remove, which, if
specified, will prevent koha-remove from deleting the database or MySQL user
when removing an instance.

Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
2012-02-02 09:15:20 +01:00

58 lines
1.5 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-remove</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Communnity</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-remove">
<refmeta>
<refentrytitle>koha-remove</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-remove</refname>
<refpurpose>Remove a Koha instance.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-remove</command>
<arg><option>--keep-mysql</option></arg>
<arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--keep-mysql</option></term>
<listitem>
<para>Leave the MySQL database and user when removing the Koha instance.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para>Remove a Koha instance.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-disable(8)</command></member>
<member><command>koha-dump(8)</command></member>
<member><command>koha-enable(8)</command></member>
<member><command>koha-restore(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>