Serve the bupstash protocol over stdin/stdout.

bupstash serve [OPTIONS] REPOSITORY


bupstash serve serves the bupstash protocol over stdin/stdout allowing interaction with a repository. Most bupstash commands operate via an instance of bupstash serve.

The serve command has flags that can be set to restrict access permissions, by default all access is permitted until the first --allow-* option is provided. These flags can be enforced ssh authorized_keys file, or through mechanisms such as sudo or doas configuration.

Clients with permission to read data may still not be able to decrypt it unless they have the correct client side decryption key.

Note that many errors are printed out of band via stderr, so alternative transports should consider how to also forward stderr data.


Allow the client to initialize new repositories.
Allow client to put more items into the repository.
Allow client to retrieve metadata and snapshot indexes for search and listing.
Allow client to retrieve data from the repository, implies --allow-list.
Allow client to remove repository items, implies --allow-list.
Allow client to run the repository garbage collector.
Allow client to sync items into the repository, i.e. be the destination of a repository sync.



$ export BUPSTASH_REPOSITORY_COMMAND="ssh -p 2020 $SERVER bupstash serve /data/repository"
$ bupstash list

Setup SSH access controls

Create a 'backups' user on your server.

In an your sshd config file in your server add the line:

Match User backups
    ForceCommand "/bin/bupstash-put-force-command.sh"

Create /bin/bupstash-put-force-command.sh on your server:

$ echo 'exec bupstash serve --allow-put /home/backups/bupstash-backups' > bupstash-put-force-command.sh
$ sudo cp bupstash-put-force-command.sh /bin/bupstash-put-force-command.sh
$ sudo chown root:root /bin/bupstash-put-force-command.sh
$ sudo chmod +x /bin/bupstash-put-force-command.sh

Now any client with ssh access to the 'backups' user will only be able to add new backups to one repository:

$ export BUPSTASH_REPOSITORY="ssh://backups@$SERVER"
$ bupstash put ./data
$ bupstash list
server has disabled query and search for this client

Logging into the server via other means will have full access to the backups repository. Different permissions can be configured using similar concepts along side different ssh configurations and keys.


bupstash, bupstash-repository