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
|
<?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>raidfile-config</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">Box Backup</refmiscinfo>
<refmiscinfo class="source">Box Backup</refmiscinfo>
<refmiscinfo class="version">0.11</refmiscinfo>
</refmeta>
<refnamediv>
<refname>raidfile-config</refname>
<refpurpose>Configure Box Backup's RAID files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>raidfile-config</command>
<arg choice="plain">config-dir</arg>
<arg choice="plain">blocksize</arg>
<arg choice="plain">dir1 <arg>dir2 <arg>dir3</arg></arg></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>raidfile-config creates a raidfile.conf file for Box Backup. This
file holds information about the directories used to store backups in. Box
Backup supports userland RAID, in a restricted RAID5 configuration, where
3 and only 3 'drives' are supported. You can read more about RAID5 (and
other RAID-levels) <ulink
url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.</para>
<refsection>
<title>Parameters</title>
<para>The parameters are as follows:</para>
<variablelist>
<varlistentry>
<term><varname>config-dir</varname></term>
<listitem>
<para>The directory path where configuration files are located.
Usually this is <filename>/etc/box</filename>.
<filename>raidfile.conf</filename> will be written in this
directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>blocksize</varname></term>
<listitem>
<para>The block size used for file storage in the system, in
bytes. Using a multiple of the file system block size is a good
strategy. Depending on the size of the files you will be backing
up, this multiple varies. Of course it also depends on the native
block size of your file system.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>dir1</varname></term>
<listitem>
<para>The first directory in the built-in RAID array.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>dir2</varname></term>
<listitem>
<para>The second directory in the built-in RAID array. If you are
not using the built-in RAID functionality, this field should be
ignored. You should not use the built-in RAID if you have a
hardware RAID solution or if you're using another type of software
RAID (like md on Linux).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>dir3</varname></term>
<listitem>
<para>The third directory in the built-in RAID array. The same
notes that apply to <varname>dir2</varname> also apply to
<varname>dir3</varname>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Note that there are currently no way to add multiple disk sets to
the raidfile.conf file using command line tools, etc. See <citerefentry>
<refentrytitle>raidfile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for details on adding more disks.</para>
</refsection>
</refsection>
<refsection>
<title>Bugs</title>
<para>If you find a bug in Box Backup, and you want to let us know about
it, join the <ulink
url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
list</ulink>, and send a description of the problem there.</para>
<para>To report a bug, give us at least the following information:</para>
<itemizedlist>
<listitem>
<para>The version of Box Backup you are running</para>
</listitem>
<listitem>
<para>The platform you are running on (hardware and OS), for both
client and server.</para>
</listitem>
<listitem>
<para>If possible attach your config files (bbstored.conf,
bbackupd.conf) to the bug report.</para>
</listitem>
<listitem>
<para>Also attach any log file output that helps shed light on the
problem you are seeing.</para>
</listitem>
<listitem>
<para>And last but certainly not least, a description of what you are
seeing, in as much detail as possible.</para>
</listitem>
</itemizedlist>
</refsection>
<refsection>
<title>Files</title>
<para><command>raidfile-config</command> generates the <citerefentry>
<refentrytitle>raidfile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> file.</para>
</refsection>
<refsection>
<title>See Also</title>
<para><citerefentry>
<refentrytitle>bbstored-config</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>bbstored.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>raidfile.conf</refentrytitle>
<manvolnum>5</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>
|
