✏️ update readme

This commit is contained in:
Sebastien Clement 2021-01-09 01:45:25 +01:00
parent 573ca5401c
commit 2e23a84659

View File

@ -16,7 +16,7 @@
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] [![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
Home Assistant snapshot backup to Nextcloud Easily backup your Home Assistant snapshots to Nextcloud
![Nextcloud Backup Screenshot](images/screenshot.png) ![Nextcloud Backup Screenshot](images/screenshot.png)
@ -27,7 +27,7 @@ Easily backup your Home Assistant snapshots to Nextcloud.
### Features ### Features
- Auto Backup : Configure this add-on to automaticly backup your HassIO instance. - Auto Backup : Configure this add-on to automaticly backup your HassIO instance.
- Auto Clean : You can specify the maximum number of local snapshots and (__ONLY__) auto backuped snapshots. - Auto Clean : You can specify the maximum number of local snapshots and (__ONLY__) auto backuped snapshots.
- ~~Restore backups.~~ (Coming Soon) - Upload backed-up snapshot to Home assistant.
> __Info:__<br> > __Info:__<br>
> Auto Clean is executed after every upload and every day at 00h30 > Auto Clean is executed after every upload and every day at 00h30
@ -69,9 +69,6 @@ Example add-on configuration:
```json ```json
{ {
"log_level": "info", "log_level": "info",
"ssl": false,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem",
} }
``` ```
@ -95,26 +92,6 @@ more severe level, e.g., `debug` also shows `info` messages. By default,
the `log_level` is set to `info`, which is the recommended setting unless the `log_level` is set to `info`, which is the recommended setting unless
you are troubleshooting. you are troubleshooting.
### Option: `ssl`
Enables/Disables SSL on the Log Viewer. Set it `true` to enable it,
`false` otherwise.
**Note**: _The SSL settings only apply to direct access and has no effect
on the Hass.io Ingress service._
### Option: `certfile`
The certificate file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io._
### Option: `keyfile`
The private key file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io._
### Option: `leave_front_door_open` ### Option: `leave_front_door_open`
Adding this option to the add-on configuration allows you to disable Adding this option to the add-on configuration allows you to disable