Skip to content

Commit d57b59e

Browse files
committed
Update documentation and repo url's
1 parent a8d9fd9 commit d57b59e

File tree

3 files changed

+47
-14
lines changed

3 files changed

+47
-14
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# @tykarol Home Assistant Add-ons
2+
3+
## About
4+
5+
Hass.io allows anyone to create add-on repositories to share their add-ons for Hass.io easily. This repository is one of those repositories, providing extra Home Assistant add-ons for your Hass.io installation.
6+
7+
The primary goal of this project is to provide you (as a Hass.io / Home Assistant user) with additional, high quality, add-ons that allow you to take your automated home to the next level.
8+
9+
## Installation
10+
11+
Adding this add-ons repository to your Hass.io Home Assistant instance is pretty easy. Follow the [official instructions](https://www.home-assistant.io/hassio/installing_third_party_addons/) on the website of Home Assistant, and use the following URL:
12+
13+
```
14+
https://github.com/tykarol/hassio-addons
15+
```
16+
17+
# License
18+
19+
MIT License
20+
21+
Copyright (c) 2020 Karol Tyka
22+
23+
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:
24+
25+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
26+
27+
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.

rsync_backups/README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,30 @@
22

33
Transfers the Hass.io backups to a remote rsync server.
44

5-
## Instalation
6-
7-
Download and place files in `rsync_backups` directory in `addons` of Home Assistant.
8-
Files from this repository should be in the `[homeassistant]/addons/rsync_backups`.
9-
105
## Configuration
116

127
This section describes each of the add-on configuration options.
138

149
Example add-on configuration:
1510

11+
```yaml
12+
server: rsync-server
13+
port: 22
14+
directory: ~/hassio-backups
15+
username: user
16+
password: password
17+
auto_purge: 0
1618
```
17-
"server": "rsync-server",
18-
"port": 22,
19-
"directory": "~/hassio-backups",
20-
"username": "user",
21-
"password": "password",
22-
"auto_purge": 0
19+
20+
or you can use also `!secret` eg.: (edit configuration in YAML):
21+
22+
```yaml
23+
server: rsync-server
24+
port: 22
25+
directory: ~/hassio-backups
26+
username: user
27+
password: '!secret rsync_backups_password'
28+
auto_purge: 0
2329
```
2430

2531
### Option: `server` (required)
@@ -64,5 +70,5 @@ Run addon in the automation, example automation below:
6470
- delay: '00:10:00'
6571
- service: 'hassio.addon_start'
6672
data:
67-
addon: 'local_rsync_backups'
73+
addon: '2caa1d32_rsync_backups' # you can get the addon id from URL when you go to the addon info
6874
```

rsync_backups/config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "Rsync Backups",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"slug": "rsync_backups",
55
"description": "Transfers the Hass.io backups to a remote rsync server.",
6-
"url": "https://github.com/tykarol/homeassistant-addon-rsync-backup",
6+
"url": "https://github.com/tykarol/hassio-addons",
77
"startup": "once",
88
"boot": "manual",
99
"arch": [

0 commit comments

Comments
 (0)