blob: 6d0113c1859d5ffc6d093b8546345d6e72f57754 (
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
144
145
146
147
148
|
<?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-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>bbstored-config</refname>
<refpurpose>Box Backup store daemon configuration file
generator</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>bbstored-config</command>
<arg choice="plain">configdir</arg>
<arg choice="plain">servername</arg>
<arg choice="plain">username</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>The bbstored-config script creates configuration files and server
certificates for a bbstored instance. It takes three parameters:</para>
<variablelist>
<varlistentry>
<term>configdir</term>
<listitem>
<para>The directory where config files will reside. A
<filename>bbstored</filename> subdirectory will be created where
several config files will reside. The
<filename>bbstored.conf</filename> file will be created in
<varname>configdir</varname>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>servername</term>
<listitem>
<para>The name of the server that is being configured. Usually the
fully qualified domain name of the machine in question.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>username</term>
<listitem>
<para>The name of the user that should be running the
<command>bbstored</command> process. Recommended name:
_bbstored.</para>
</listitem>
</varlistentry>
</variablelist>
<para>A valid <citerefentry>
<refentrytitle>raidfile.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> must be found in configdir. Several steps are taken
during the run of <command>bbstored-config</command>:</para>
<itemizedlist>
<listitem>
<para>Server certificates are created. This requires interaction from
the operator.</para>
</listitem>
<listitem>
<para>The RAID volumes are checked to ensure that the configuration is
consistent and will work.</para>
</listitem>
<listitem>
<para>Instructions for next steps to take are shown. These steps may
be different for different OS platforms, so pay close attention to
these instructions.</para>
</listitem>
</itemizedlist>
</refsection>
<refsection>
<title>Files</title>
<para><filename>/etc/box/bbstored.conf</filename></para>
</refsection>
<refsection>
<title>See Also</title>
<para><citerefentry>
<refentrytitle>bbstored.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>bbstored</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>bbstored-certs</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>
|
