.\"     Title: bbstored.conf
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 11/13/2023
.\"    Manual: Box Backup
.\"    Source: Box Backup 0.11
.\"
.TH "BBSTORED\.CONF" "5" "11/13/2023" "Box Backup 0\.11" "Box Backup"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
bbstored.conf - Box Backup store daemon configuration file
.SH "SYNOPSIS"
.HP 23
\fB/etc/box/bbstored\.conf\fR
.SH "DESCRIPTION"
.PP
The following configuration options are valid:
.PP
\fIRaidFileConf\fR
.RS 4
Specifies the path to the
\fBraidfile.conf\fR(5)\. This is normally
\fI/etc/box/raidfile\.conf\fR\.
.RE
.PP
\fIAccountDatabase\fR
.RS 4
Specifies the path to the account database created by
\fBbbstoreaccounts\fR(8)\. This is usually
\fI/etc/box/bbstored/accounts\.txt\fR\.
.RE
.PP
\fIExtendedLogging\fR
.RS 4
Specifies whether extended logging should be enabled to show what commands are being received from clients\.
.RE
.PP
\fITimeBetweenHousekeeping\fR
.RS 4
How long between scanning for files which need deleting\.
.RE
.PP
\fIServer\fR
.RS 4
These options relate to the actual daemon\..PP
\fIPidFile\fR
.RS 4
The location of the pidfile, where the daemon\(aqs process ID is kept\.
.RE
.PP
\fIUser\fR
.RS 4
The user to run as\.
.RE
.PP
\fIListenAddresses\fR
.RS 4
The interface addresses to listen on\. Hostnames may be used instead of IP addresses\. The format is:
\fBinet:hostname\fR
or
\fBinet:10\.0\.0\.1\fR\.
.RE
.PP
\fICertificateFile\fR
.RS 4
The path to the server\(aqs public certificate\.
.RE
.PP
\fIPrivateKeyFile\fR
.RS 4
The path to the server\(aqs private key\. This should only be readable by root and/or the
\fBUser\fR\.
.RE
.PP
\fITrustedCAsFile\fR
.RS 4
The Certificate Authority created by
\fBbbstored-certs\fR(8)\.
.RE
.RE
.SH "EXAMPLES"
.PP
The following is an example bbstored\.conf:
.PP
.RS 4
.nf
RaidFileConf = /etc/box/raidfile\.conf
AccountDatabase = /etc/box/bbstored/accounts\.txt

TimeBetweenHousekeeping = 900

Server
{
  PidFile = /var/run/bbstored\.pid
  User = _bbstored
  ListenAddresses = inet:server\.example\.com
  CertificateFile = /etc/box/bbstored/server\.example\.com\-cert\.pem
  PrivateKeyFile = /etc/box/bbstored/server\.example\.com\-key\.pem
  TrustedCAsFile = /etc/box/bbstored/clientCA\.pem
}
.fi
.RE
.SH "FILES"
.PP
\fI/etc/box/bbstored\.conf\fR
.SH "SEE ALSO"
.PP
\fBbbstored\fR(8),
\fBbbstored-config\fR(8),
\fBraidfile-config\fR(8)
.SH "AUTHORS"
.PP
Ben Summers
.PP
Per Thomsen
.PP
James O\(aqGorman