1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<refmeta>
<refentrytitle>bbstored.conf</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">Box Backup</refmiscinfo>
<refmiscinfo class="source">Box Backup</refmiscinfo>
<refmiscinfo class="version">0.11</refmiscinfo>
</refmeta>
<refnamediv>
<refname>bbstored.conf</refname>
<refpurpose>Box Backup store daemon configuration file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>/etc/box/bbstored.conf</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>The following configuration options are valid:</para>
<variablelist>
<varlistentry>
<term><varname>RaidFileConf</varname></term>
<listitem>
<para>Specifies the path to the <citerefentry>
<refentrytitle>raidfile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>. This is normally
<filename>/etc/box/raidfile.conf</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>AccountDatabase</varname></term>
<listitem>
<para>Specifies the path to the account database created by
<citerefentry>
<refentrytitle>bbstoreaccounts</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>. This is usually
<filename>/etc/box/bbstored/accounts.txt</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ExtendedLogging</varname></term>
<listitem>
<para>Specifies whether extended logging should be enabled to show
what commands are being received from clients.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>TimeBetweenHousekeeping</varname></term>
<listitem>
<para>How long between scanning for files which need
deleting.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Server</varname></term>
<listitem>
<para>These options relate to the actual daemon.<variablelist>
<varlistentry>
<term><varname>PidFile</varname></term>
<listitem>
<para>The location of the pidfile, where the daemon's
process ID is kept.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>User</varname></term>
<listitem>
<para>The user to run as.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ListenAddresses</varname></term>
<listitem>
<para>The interface addresses to listen on. Hostnames may be
used instead of IP addresses. The format is:
<option>inet:hostname</option> or
<option>inet:10.0.0.1</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>CertificateFile</varname></term>
<listitem>
<para>The path to the server's public certificate.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>PrivateKeyFile</varname></term>
<listitem>
<para>The path to the server's private key. This should only
be readable by root and/or the <option>User</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>TrustedCAsFile</varname></term>
<listitem>
<para>The Certificate Authority created by <citerefentry>
<refentrytitle>bbstored-certs</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.</para>
</listitem>
</varlistentry>
</variablelist></para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Examples</title>
<para>The following is an example bbstored.conf:</para>
<para><programlisting>RaidFileConf = /etc/box/raidfile.conf
AccountDatabase = /etc/box/bbstored/accounts.txt
TimeBetweenHousekeeping = 900
Server
{
PidFile = /var/run/bbstored.pid
User = _bbstored
ListenAddresses = inet:server.example.com
CertificateFile = /etc/box/bbstored/server.example.com-cert.pem
PrivateKeyFile = /etc/box/bbstored/server.example.com-key.pem
TrustedCAsFile = /etc/box/bbstored/clientCA.pem
}</programlisting></para>
</refsection>
<refsection>
<title>Files</title>
<para><filename>/etc/box/bbstored.conf</filename></para>
</refsection>
<refsection>
<title>See Also</title>
<para><citerefentry>
<refentrytitle>bbstored</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>bbstored-config</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>raidfile-config</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry></para>
</refsection>
<refsection>
<title>Authors</title>
<para><author>
<personname>Ben Summers</personname>
</author></para>
<para><author>
<personname>Per Thomsen</personname>
</author></para>
<para><author>
<personname>James O'Gorman</personname>
</author></para>
</refsection>
</refentry>
|