mirrors/recipes
1
0
Fork 0
mirror of https://github.com/TandoorRecipes/recipes.git synced 2026-01-01 04:10:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add updates and backup instructions

Browse Source
This commit is contained in:
Alexandre
2022-09-10 22:33:06 +02:00
committed by GitHub
parent 5423019a14
commit 35bb3c9eb1
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/install/homeassistant.md
View File

@@ -11,19 +11,14 @@ In addition to its large depth of native functions, modular addons can be added
### Installation
Once you have a running Home Assistant system, the next step is to add the addon's maintainer custom repository to your system.
This is performed by clicking on the button below, and simply filling your HA url.
1. [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
1. [![Install the addon](https://my.home-assistant.io/badges/supervisor_store.svg)](https://my.home-assistant.io/redirect/supervisor_store)
1. Once you have a running Home Assistant system, the next step is to add the addon's maintainer custom repository to your system. This is performed by clicking on the button below, and simply filling your HA url. [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
1. Install the addon [![Install the addon](https://my.home-assistant.io/badges/supervisor_store.svg)](https://my.home-assistant.io/redirect/supervisor_store)
1. Set the add-on options to your preferences (see below)
1. Start the add-on.
1. Start the add-on
1. Check the logs of the add-on to see if everything went well.
1. Open the webUI (either through Ingress, or direct webUI) and adapt the software options
1. Open the webUI (either through Ingress, or direct webUI with http://homeassistant.local:9928) and adapt the software options
1. Star my repository to encourage me : https://github.com/alexbelgium/hassio-addon
Add data is stored in `/config/addons_config/tandoor_recipes`, so be sure to backup this folder in addition to the addon itself when updating. Updates are an automatic process, so please always backup when updating.
### Configuration
The following environment variable are configurable from the addon options. Please see the [Docker documentation](https://docs.tandoor.dev/install/docker/) for more information on how they should be filled.
@@ -33,7 +28,7 @@ Required :
"ALLOWED_HOSTS": "your system url", # You need to input your homeassistant urls (comma separated, without space) to allow ingress to work
"DB_TYPE": "list(sqlite|postgresql_external|mariadb_addon)" # Type of database to use. Mariadb_addon allows to be automatically configured if the maria_db addon is already installed on your system. Sqlite is an internal database. For postgresql_external, you'll need to fill the below settings
"SECRET_KEY": "str", # Your secret key
"PORT": 9928 # By default, the webui is available on http://HAurl:9928. If you ever need to change the port, you should never do it within the app, but only through this option
"PORT": 9928 # By default, the webui is available on http://homeassistant.local:9928. If you ever need to change the port, you should never do it within the app, but only through this option
Optional :
"POSTGRES_HOST": "str?", # Needed for postgresql_external
"POSTGRES_PORT": "str?", # Needed for postgresql_external
@@ -42,6 +37,12 @@ Optional :
"POSTGRES_DB": "str?" # Needed for postgresql_external
```
### Updates and backups
The alexbelgium's repo incorporates a script that aligns every 3 days the addon to the containers released. Just wait a few hours for HA to refreshes its repo list and the uodate will be proposed automatically in your HA system.
It is recommended to frequently backup. All data is stored outside of the addon, the main location `/config/addons_config/tandoor_recipes`, so be sure to backup this folder in addition to the addon itself when updating. If you have selected mariadb as database option, don't forget to also backup it.
### Support
Issues related to the addon itself should be reported on the [maintainer repo][repository].