summaryrefslogtreecommitdiff
path: root/boxbackup/bbstored-config.xml
blob: b7658782baebe8c858aa5477b704ed43630dd201 (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
<?xml version="1.0" encoding="UTF-8"?>
<refentry>
  <refmeta>
    <refentrytitle>bbstored-config</refentrytitle>

    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>bbstored-config</refname>

    <refpurpose>Create config files for bbstored</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bbstored-config &lt;configdir&gt; &lt;servername&gt;
      &lt;username&gt;</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para>The <literal>bbstored-config</literal> script creates config files
    and server certificates for a bbstored instance. It takes three
    parameters:</para>

    <itemizedlist>
      <listitem>
        <para><literal>configdir</literal>: The directory where config files
        will reside. A subdirectory bbstored will be created, where several
        config files will reside. the <literal>bbstored.conf</literal> file
        will be created in <literal>configdir</literal>.</para>
      </listitem>

      <listitem>
        <para><literal>servername</literal>: The name of the server that is
        being configured. Usually the fully qualified domain name of the
        machine in question.</para>
      </listitem>

      <listitem>
        <para><literal>username</literal>: The name of the user that should be
        running the bbstored processes. Recommended name:
        _<literal>bbstored.</literal></para>
      </listitem>
    </itemizedlist>

    <para>A valid raidfile.conf(5) must be found in configdir. Several steps
    are taken during the run of bbstored-config:</para>

    <itemizedlist>
      <listitem>
        <para>Configuration files are created.</para>
      </listitem>

      <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>Author</title>

    <para>Ben Summers and contributors. For help, please go to the <ulink
    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
    Backup <ulink
    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
    list.</ulink></para>
  </refsection>

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

    <para><literal>raidfile-config(1)</literal></para>

    <para><literal>bbstored.conf(5)</literal></para>

    <para><literal>raidfile.conf(5)</literal></para>
  </refsection>

  <refsection>
    <title>Files</title>

    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
    configuration file, usually located in
    <filename>/etc/box/bbstored.conf</filename>.</para>
  </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>
</refentry>