.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.SH "SYNOPSIS"
Initialize a bupstash repository\.
.P
\fBbupstash init [OPTIONS]\fR
.SH "DESCRIPTION"
\fBbupstash init\fR initializes a repository\. If \fBREPOSITORY\fR already exists, the command fails\.
.P
Currently it is not recommend using bupstash on a network filesystem\.
.P
For details about the contents of the package store after initialization, see bupstash\-repository(7)\.
.SH "OPTIONS"
.TP
\-r, \-\-repository REPO
The repository to connect to\. May be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\. If not specified, is set to \fBBUPSTASH_REPOSITORY\fR\.
.TP
\-\-storage SPEC
Accepts 'dir' or a json storage specification\. The default storage is 'dir' and stores encrypted data blocks in a repository local data directory\.
.IP
See the storage specs section for supported json specifications and examples\.
.SH "ENVIRONMENT"
.TP
BUPSTASH_REPOSITORY
The repository to connect to\. May be of the form \fBssh://$SERVER/$PATH\fR for remote repositories if ssh access is configured\.
.TP
BUPSTASH_REPOSITORY_COMMAND
A command to run to connect to an instance of bupstash\-serve(1)\. This allows more complex connections to the repository for less common use cases\.
.SH "EXAMPLES"
.nf
$ export BUPSTASH_REPOSITORY=\./my\-repository
$ bupstash init

$ export BUPSTASH_REPOSITORY=ssh://$SERVER/home/backups/bupstash\-backups
$ bupstash init
.fi
.SH "JSON STORAGE SPECS"
Each storage specification consists of a type designator and a set of type specific parameters\.
.SS "Dir storage"
Dir storage is an alias for \fB\-\-storage dir\fR and is generally not needed\.
.P
Example:
.IP "" 4
.nf
$ bupstash init \-\-storage '{"Dir" : {}}''
.fi
.IP "" 0
.SS "External storage"
The external storage engine stores data via an external socket, documentation is pending interface stabilization\.
.P
Example:
.IP "" 4
.nf
$ bupstash init \-\-storage '{"External" : {"socket_path" : "/plugin/socket\.sock", "path" : "plugin\-specific\-path"}}''
.fi
.IP "" 0
.SH "SEE ALSO"
bupstash(1), bupstash\-repository(7)