From ba247f7f9f7c49741749bdee4765f1ec78734d4f Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Thu, 3 Jun 2021 21:39:24 +0100 Subject: [PATCH] Small changes to docs --- README.md | 2 ++ docs/backup-restore.md | 9 ++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6b1d17f9..9cf2c0b9 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,8 @@ Configuration files are located in [`./public/`](https://github.com/Lissy93/dash Also within `./public` you'll find normal website assets, including `favicon.ico`, `manifest.json`, `robots.txt` and `web-icons/*`. There's no need to modify these, but you can do so if you wish. +Note that the conf.yml file is where all config is read from. If you make any modifications through the web interface, you will need to export them into this file in order for your changes to persist. + ### The Conf File 📄 All app config is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) (in [YAML Format](https://yaml.org/)). diff --git a/docs/backup-restore.md b/docs/backup-restore.md index 76fcccd0..11c578e9 100644 --- a/docs/backup-restore.md +++ b/docs/backup-restore.md @@ -5,11 +5,12 @@ Dashy has a built-in feature for securely backing up your config to a hosted clo This is useful not only for backing up your configuration off-site, but it also enables Dashy to be used without having write a YAML config file, and makes it possible to use a public hosted instance, without the need to self-host.

- +

### How it Works -Your local config compressed, and then encrypted using AES encryption, using a password of your choice as the key. The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) (a platform for running serverless functions), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store. + +All data is encrypted before being sent to the backend. In Dashy, this is done in [`CloudBackup.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/CloudBackup.js), using [crypto.js](https://github.com/brix/crypto-js)'s AES method, using the users chosen password as the key. The data is then sent to a [Cloudflare worker](https://developers.cloudflare.com/workers/learning/how-workers-works) (a platform for running serverless functions), and stored in a [KV](https://developers.cloudflare.com/workers/learning/how-kv-works) data store. ### Creating a Backup @@ -29,7 +30,9 @@ Having said that, although the code uses robust security libraries and is open s ### Fair Use Policy -Maximum of 24mb of storage per user. Please do not repeatedly hit the endpoint, as if the quota is exceeded the service may become less available to other users. Abuse will result in your IP being banned. +Maximum of 24mb of storage per user. Please do not repeatedly hit the endpoint, as if the quota is exceeded the service may become less available to other users. Abuse may result in your IP being temporarily banned by Cloudflare. + +--- ### Self-Hosting the Backup Server