backups/README.md

# backupd

a dead simple backup server

## usage

### as a hoster

to get started, `git clone` this repo to a permanent location, and create `docker-compose.yml` and `config.json` from their `.example` files. modify those to your likind and `docker-compose up -d` it.

to create a new client, add an entry to `config.json` like in example. don't forget to put their password's `SHA256` sum in the `keySha256Sum` field.

### as a client

first step is get your key from the hoster, or make a client yourself if you are the hoster.

then, see [the API reference](./openapi.yml)
init: repo 2024-05-11 11:46:23 +02:00			`# backupd`
docs: add openapi.yml and readme.md 2024-05-11 14:28:37 +02:00
			`a dead simple backup server`

			`## usage`

			`### as a hoster`

			to get started, `git clone` this repo to a permanent location, and create `docker-compose.yml` and `config.json` from their `.example` files. modify those to your likind and `docker-compose up -d` it.

			to create a new client, add an entry to `config.json` like in example. don't forget to put their password's `SHA256` sum in the `keySha256Sum` field.

			`### as a client`

			`first step is get your key from the hoster, or make a client yourself if you are the hoster.`

			`then, see [the API reference](./openapi.yml)`