bupstash-init(1)

Usage

Initialize a bupstash repository.

bupstash init [OPTIONS]

bupstash init initializes a repository. If REPOSITORY already exists, the command fails.

Currently it is not recommend using bupstash on a network filesystem.

For details about the contents of the package store after initialization, see bupstash-repository(7).

-r, --repository REPO: The repository to connect to. May be of the form ssh://$SERVER/$PATH for remote repositories if ssh access is configured. If not specified, is set to BUPSTASH_REPOSITORY.

--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.

: See the storage specs section for supported json specifications and examples.

BUPSTASH_REPOSITORY: The repository to connect to. May be of the form ssh://$SERVER/$PATH for remote repositories if ssh access is configured.

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.

$ export BUPSTASH_REPOSITORY=./my-repository
$ bupstash init
$ export BUPSTASH_REPOSITORY=ssh://$SERVER/home/backups/bupstash-backups
$ bupstash init

Each storage specification consists of a type designator and a set of type specific parameters.

Dir storage is an alias for --storage dir and is generally not needed.

Example:

The external storage engine stores data via an external socket, documentation is pending interface stabilization.

Example:

: $ bupstash init --storage '{"External" : {"socket_path" : "/plugin/socket.sock", "path" : "plugin-specific-path"}}''