hassio-nextcloud-backup/nextcloud_backup/README.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

2020-10-12 15:54:12 +02:00
# Home Assistant Add-ons: Nextcloud Backup
2019-12-19 15:08:47 +01:00
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
2019-12-29 17:39:23 +01:00
[![Community Forum][forum-shield]][forum]
2019-12-19 15:08:47 +01:00
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
## About
2020-10-12 15:54:12 +02:00
Easily backup your Home Assistant snapshots to Nextcloud.
2020-04-24 04:32:04 +02:00
Auto backup can be configured via the web interface.
2020-01-10 20:33:40 +01:00
### Features
- Auto Backup : Configure this add-on to automaticly backup your HassIO instance.
2020-04-24 04:32:04 +02:00
- Auto Clean : You can specify the maximum number of local snapshots and (__ONLY__) auto backed-up snapshots.
2021-01-09 00:27:46 +01:00
- Upload backed-up snapshot to Home assistant.
2020-04-24 04:32:04 +02:00
> __Info:__
2020-01-10 20:33:40 +01:00
> Auto Clean is executed after every upload and every day at 00h30
## NextCloud config
2020-04-24 04:32:04 +02:00
First, you need to configure all your Nextcloud information.
2020-01-10 20:33:40 +01:00
To do this:
1. Open the add-on Web UI
1. Open NextCloud config menu (Top right gear, and Nexcloud)
2020-04-24 04:32:04 +02:00
1. If your NextCloud instance uses `HTTPS`, enable the `SSL` lever
2020-01-10 20:33:40 +01:00
1. Enter the `hostname` of the NextCloud instance. You can specify a custom port by adding `:[port]` at the end of the hostname (`exemple.com:8080`)
2020-04-24 04:32:04 +02:00
1. Now enter the Nextcloud username that you would like this add-on to use.
1. For password, we highly recommend using an `App Password`.
>To generate a `App Password`, go into your personal setting into Nextcloud, Security page. You can generate one via the `Devices & sessions` section. Simply enter a name and hit `Create new app password`.
2020-01-10 20:33:40 +01:00
2019-12-19 15:08:47 +01:00
[Click here for the full documentation][docs]
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/seb6596
2019-12-29 18:58:51 +01:00
[docs]: https://github.com/Sebclem/hassio-nextcloud-backup/blob/master/README.md
2019-12-19 15:08:47 +01:00
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/
2021-01-04 11:02:19 +01:00
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
2019-12-19 15:08:47 +01:00
[project-stage-shield]: https://img.shields.io/badge/project%20stage-developpement-yellow.svg
2019-12-29 18:53:46 +01:00
[release-shield]: https://img.shields.io/github/release/Sebclem/hassio-nextcloud-backup.svg
2020-04-24 04:32:04 +02:00
[release]: https://github.com/Sebclem/hassio-nextcloud-backup/releases