'\" t
.\"     Title: instances.conf
.\"    Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 03/06/2012
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "INSTANCES\&.CONF" "5" "03/06/2012" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
instances.conf_ \- zorp(8) instances database
.SH "DESCRIPTION"
.PP
The
instances\&.conf
file describes the
\fBzorp(8)\fR
instances to be run on the system\&. It is processed by
\fBzorpctl(8)\fR
line by line, each line having the structure described below\&. Empty lines and lines beginning with \*(Aq#\*(Aq are comments ignored by
\fBzorpctl\fR\&.
.SH "STRUCTURE"
.PP

\fBinstance\-name parameters [\-\- zorpctl\-options]\fR
.PP

\fIinstance\-name\fR
is the name of the Zorp instance to be started; it is passed to
\fBzorp\fR
with its
\fB\-\-as\fR
parameter\&. Instance names may consist of the characters [a\-zA\-Z0\-9_] and must begin with a letter\&.
.PP

\fIparameters\fR
are space separated parameters entered into the zorp command\-line\&. For details on these command\-line parameters see
zorp(8)\&.
.PP

\fIzorpctl\-options\fR
are space separated parameters control startup specific options\&. They are processed by
\fBzorpctl\fR
itself\&. The following
\fBzorpctl\fR
options are available:
.PP
\fB\-\-auto\-restart\fR or \fB\-A\fR
.RS 4
Enable the automatic restart feature of
\fBzorpctl\fR\&. When an instance is in auto\-restart mode, it is restarted automatically in case the instance exits\&.
.RE
.PP
\fB\-\-no\-auto\-restart\fR or \fB\-a\fR
.RS 4
Disable automatic restart for this instance\&.
.RE
.PP
\fB\-\-fd\-limit <number>\fR or \fB\-f <number>\fR
.RS 4
Set the file descriptor limit to <number>\&. The file descriptor limit defaults to the number of threads (specified by the
\fI\-\-threads\fR
parameter of
zorp(8)) multiplied by 4\&.
.RE
.PP
\fB\-\-process\-limit <number>\fR or \fB\-p <number>\fR
.RS 4
Set the process limit to <number>\&. The process limit defaults to the number of threads (specified by the
\fI\-\-threads\fR
parameter of
zorp(8)) multiplied by 2\&.
.RE
.PP
\fB\-\-enable\-core\fR
.RS 4
Explicitly enable core dumps for Zorp processes\&. The core limit is inherited from the local starting environment (e\&.g\&.: starting shell) if not specified\&.
.RE
.PP
\fB\-\-parallel\-instances <number>\fR or \fB\-P <number> \fR
.RS 4
Run <number> of processes for the instance\&.
\fBzorpctl\fR
starts exactly one Zorp process in master mode and <number> of slave Zorp processes\&. This mode of operation is incompatible with old\-style dispatchers, you must use the new rule\-based policy with this option\&.
.RE
.SH "EXAMPLES"
.PP
.PP

\fBzorp_ftp \-\-policy /etc/zorp/policy\&.py \-\-verbose 5 \fR
.PP
The line above describes a Zorp instance named
\fIzorp_ftp\fR
using policy file
\fI/etc/zorp/policy\&.py\fR, and having verbosity level 5\&.
.PP

\fBzorp_intra \-v4 \-p /etc/zorp/policy\&.py \-\-threads 500 \-\-no\-auto\-restart \-\-fd\-limit 1024 \-\-process\-limit 512\fR
.PP
This line describes a zorp instance named
\fIzorp_intra\fR
using the policy file
/etc/zorp/policy\&.py, verbosity level 4\&. The maximum number of threads is set to 500, file descriptor limit to 1024, process limit to 512\&.
.SH "FILES"
.PP
The default location of
instances\&.conf
is
/etc/zorp/instances\&.conf\&. Defaults for zorpctl tunables can be specified in
/etc/zorp/zorpctl\&.
.SH "AUTHOR"
.PP
This manual page was written by the BalaBit Documentation Team <documentation@balabit\&.com>\&.
.SH "COPYRIGHT"
.PP
Copyright \(co 2006 BalaBit IT Security Ltd\&. All rights reserved\&. For more information about the legal status of this document please read:
\m[blue]\fBhttp://www\&.balabit\&.com/products/zorp/docs/legal_notice\&.bbq\fR\m[]