Serving a Kloset Store over the Network

#

Plakar can expose a Kloset Store over HTTP using the plakar server command. This allows other machines to access the store over the network.

There are two main reasons to use plakar server:

  • Accessing a store over HTTP. Some environments only expose storage over HTTP. For example, a NAS that is reachable over HTTP but not over SSH. In these cases, plakar server lets you bridge the gap by re-exposing a store through HTTP.
  • Protection against snapshot deletion. By default, plakar server refuses delete operations. This is useful when multiple machines push backups to a shared store. If one of those machines is compromised, an attacker cannot use it to delete snapshots.

In all cases, clients still need the repository passphrase to access the store, and all snapshot data remains fully encrypted in transit.

Starting an HTTP server

#

Assume you have a Kloset Store located at /var/backups. To expose it over HTTP, run:

$ plakar at /var/backups server

By default, plakar server listens on http://localhost:9876.

Accessing the store over HTTP

#

In Plakar v1.0.6 and earlier, the HTTP integration must be installed for you to be able to access stores over the network. See the HTTP integration page for installation instructions.

Once installed, you can access the store through the network address:

$ plakar at http://localhost:9876 ls

Listening on a different address

#

Use the -listen flag to change the listening address and port. To listen on all interfaces on port 12345:

$ plakar at /var/backups server -listen :12345

To listen on a specific address, for example 192.168.1.10:

$ plakar at /var/backups server -listen 192.168.1.10:12345

Remote clients on the same network can then reach the store using:

$ plakar at http://192.168.1.10:12345 ls

Enabling delete operations

#

Delete operations are disabled by default. To allow them explicitly:

$ plakar at /var/backups server -allow-delete

Serving remote stores

#

plakar server can also expose non-local stores. For example, to expose an SFTP-backed store over HTTP:

$ plakar at sftp://example.org server

Limitations

#
  • Native HTTPS support is not available in Plakar v1.0.6 and earlier. If encryption in transit is required, use a reverse proxy such as Nginx. Note that snapshot data transiting through plakar server is always fully encrypted regardless.