summaryrefslogtreecommitdiff
path: root/docs/bbstored-certs.xml
blob: 79308089adfd83e0e2d84c8750702347668ffe8b (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
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
<?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-certs</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-certs</refname>

    <refpurpose>Manage certificates for the Box Backup system</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bbstored-certs</command>

      <arg choice="plain">certs-dir</arg>

      <arg choice="plain">command</arg>

      <arg>arguments</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para><command>bbstored-certs</command> creates and signs certificates for
    use in Box Backup. It allows the user to create and sign the server keys,
    as well as signing client keys.</para>

    <para>All commands must be followed by the <varname>certs-dir</varname>,
    which is the directory in which the certificates are stored.</para>

    <refsection>
      <title>Commands</title>

      <para>There are 3 commands:</para>

      <variablelist>
        <varlistentry>
          <term><command>init</command></term>

          <listitem>
            <para>Create the <varname>certs-dir</varname>, and generate the
            server keys for bbstored. <varname>certs-dir</varname> cannot
            exist before running the command.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term><command>sign-server</command>
          <varname>servercsrfile</varname></term>

          <listitem>
            <para>Sign the server certificate. The
            <varname>servercsrfile</varname> is the file generated by the
            <command>init</command> command.</para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term><command>sign</command>
          <varname>clientcsrfile</varname></term>

          <listitem>
            <para>Sign a client certificate. The
            <varname>clientcsrfile</varname> is generated during client setup.
            See <citerefentry>
                <refentrytitle>bbackupd-config</refentrytitle>

                <manvolnum>8</manvolnum>
              </citerefentry>. Send the signed certificate back to the client,
            and install according to the instructions given by
            <command>bbackupd-config</command>.</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
  </refsection>

  <refsection>
    <title>Files</title>

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

        <manvolnum>8</manvolnum>
      </citerefentry> generates the <citerefentry>
        <refentrytitle>raidfile.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry> file.</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>

  <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>bbstoreaccounts</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>