summaryrefslogtreecommitdiff
path: root/docs/raidfile.conf.xml
blob: 7a8b641025c509e4ea4702aff7badc5a0e3f7217 (plain)
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
<?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.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>raidfile.conf</refname>

    <refpurpose>Userland RAID for Box Backup</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/box/raidfile.conf</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para>The raidfile.conf is usually generated by <citerefentry>
        <refentrytitle>raidfile-config</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry> but may be manually edited if the store locations move
    or if more than one disc set is required.</para>

    <para><variablelist>
        <varlistentry>
          <term>disc<varname>X</varname></term>

          <listitem>
            <para>Specifies a set of discs.</para>

            <para><variablelist>
                <varlistentry>
                  <term><varname>SetNumber</varname></term>

                  <listitem>
                    <para>The set number of the RAID disc, referenced by each
                    account.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>BlockSize</varname></term>

                  <listitem>
                    <para>The block size of the file system (usually 2048).
                    Under BSD with FFS, set this to your file system's
                    fragment size (most likely an 8th of the block
                    size).</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>Dir0</varname></term>

                  <listitem>
                    <para>The first directory in the RAID array.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>Dir1</varname></term>

                  <listitem>
                    <para>The second directory in the RAID array. If you do
                    not wish to use the built-in RAID functionality, this
                    field should be set to the same as
                    <varname>Dir0</varname>. 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>Dir2</varname></term>

                  <listitem>
                    <para>The third directory in the RAID array. The same
                    notes that apply to <varname>Dir2</varname> also apply to
                    <varname>Dir3</varname>.</para>
                  </listitem>
                </varlistentry>
              </variablelist></para>
          </listitem>
        </varlistentry>
      </variablelist></para>
  </refsection>

  <refsection>
    <title>Files</title>

    <para><filename>/etc/box/raidfile.conf</filename></para>
  </refsection>

  <refsection>
    <title>See Also</title>

    <para><citerefentry>
        <refentrytitle>raidfile-config</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>bbstored.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>