mirror of
https://github.com/Sebclem/hassio-nextcloud-backup.git
synced 2024-08-18 13:44:55 +02:00
187 lines
6.6 KiB
Markdown
187 lines
6.6 KiB
Markdown
# Hass.io Add-ons: Nextcloud Backup
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
![Project Stage][project-stage-shield]
|
|
[![License][license-shield]](LICENSE.md)
|
|
|
|
![Supports aarch64 Architecture][aarch64-shield]
|
|
![Supports amd64 Architecture][amd64-shield]
|
|
![Supports armhf Architecture][armhf-shield]
|
|
![Supports armv7 Architecture][armv7-shield]
|
|
![Supports i386 Architecture][i386-shield]
|
|
|
|
![Project Maintenance][maintenance-shield]
|
|
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
|
|
|
Hass.io snapshot backup to Nextcloud
|
|
|
|
![Nextcloud Backup Screenshot](images/screenshot.png)
|
|
|
|
## About
|
|
|
|
Easily backup your Hass.io snapshots to Nextcloud.
|
|
Auto backup can be configure with the web interface.
|
|
|
|
## Installation
|
|
|
|
`Coming soon`
|
|
|
|
~~The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.~~
|
|
|
|
~~1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance.~~
|
|
~~1. Install the "Nextcloud Backup" add-on.~~
|
|
~~1. Start the "Nextcloud Backup" add-on~~
|
|
~~1. Check the logs of the "Nextcloud Backup" add-on to see if everything went well.~~
|
|
~~1. Open the web UI for the "Nextcloud Backup" to configure the add-on.~~
|
|
|
|
|
|
~~**NOTE**: Do not add this repository to Hass.io, please use:
|
|
`https://github.com/hassio-addons/repository`.~~
|
|
|
|
## Configuration
|
|
|
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
|
|
|
Example add-on configuration:
|
|
|
|
```json
|
|
{
|
|
"log_level": "info",
|
|
"ssl": false,
|
|
"certfile": "fullchain.pem",
|
|
"keyfile": "privkey.pem",
|
|
}
|
|
```
|
|
|
|
**Note**: _This is just an example, don't copy and paste it! Create your own!_
|
|
|
|
### Option: `log_level`
|
|
|
|
The `log_level` option controls the level of log output by the addon and can
|
|
be changed to be more or less verbose, which might be useful when you are
|
|
dealing with an unknown issue. Possible values are:
|
|
|
|
- `trace`: Show every detail, like all called internal functions.
|
|
- `debug`: Shows detailed debug information.
|
|
- `info`: Normal (usually) interesting events.
|
|
- `warning`: Exceptional occurrences that are not errors.
|
|
- `error`: Runtime errors that do not require immediate action.
|
|
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
|
|
|
Please note that each level automatically includes log messages from a
|
|
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
|
|
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`
|
|
|
|
Adding this option to the add-on configuration allows you to disable
|
|
authentication on the add-on by setting it to `true` and leaving the
|
|
username and password empty.
|
|
|
|
**Note**: _We STRONGLY suggest, not to use this, even if this add-on is
|
|
only exposed to your internal network. USE AT YOUR OWN RISK!_
|
|
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
You have several options to get them answered:
|
|
|
|
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
|
Assistant discussions and questions.
|
|
- The Home Assistant [Community Forum][forum].
|
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
|
|
|
You could also [open an issue here][issue] GitHub.
|
|
|
|
<!-- ## Contributing
|
|
|
|
This is an active open-source project. We are always open to people who want to
|
|
use the code or contribute to it.
|
|
|
|
We have set up a separate document containing our
|
|
[contribution guidelines](CONTRIBUTING.md).
|
|
|
|
Thank you for being involved! :heart_eyes: -->
|
|
|
|
## Authors & contributors
|
|
|
|
The original setup of this repository is by [Sebastien Clement][Sebclem].
|
|
|
|
For a full list of all authors and contributors,
|
|
check [the contributor's page][contributors].
|
|
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2019 Sébastien Clément
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
|
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
|
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
|
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
|
[buymeacoffee]: https://www.buymeacoffee.com/seb6596
|
|
[Sebclem]: https://github.com/Sebclem
|
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io/
|
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
|
[issue]: https://github.com/hassio-addons/addon-log-viewer/issues
|
|
[license-shield]: https://img.shields.io/github/license/Sebclem/hassio-nextcloud-backup.svg
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-Beta-red.svg
|
|
[reddit]: https://reddit.com/r/homeassistant
|
|
[releases-shield]: https://img.shields.io/github/release/Sebclem/hassio-nextcloud-backup.svg
|
|
[releases]: https://github.com/Sebclem/hassio-nextcloud-backup/releases
|
|
[repository]: https://github.com/hassio-addons/repository
|
|
[version-shield]: https://images.microbadger.com/badges/version/hassioaddons/log-viewer.svg
|
|
[contributors]: https://github.com/Sebclem/hassio-nextcloud-backup/graphs/contributors
|
|
[semver]: https://semver.org/spec/v2.0.0.htm
|