Files
hassio-addons/tandoor_recipes/README.md
2022-01-12 18:39:06 +01:00

62 lines
2.9 KiB
Markdown

# Hass.io Add-ons: Tandoor recipes
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
![Supports
Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
![Supports smb mounts][smb-shield]
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
[![Stargazers repo roster for @alexbelgium/hassio-addons](https://reporoster.com/stars/alexbelgium/hassio-addons)](https://github.com/alexbelgium/hassio-addons/stargazers)
## About
[Tandoor recipes](https://github.com/TandoorRecipes/recipes) is meant for people with a collection of recipes they want to share with family and friends or simply store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page.
## Configuration
Please check Tandoor Recipes documentation : https://docs.tandoor.dev/install/docker/
```yaml
"SECRET_KEY": "str",
"DB_TYPE": "list(sqlite|postgresql_external|mariadb_addon)" # Mariadb is automatically configured is the addon is installed, sqlite does not need configuration
"ALLOWED_HOSTS": "str?",
"POSTGRES_HOST": "str?", # Needed for postgresql_external
"POSTGRES_PORT": "str?", # Needed for postgresql_external
"POSTGRES_USER": "str?", # Needed for postgresql_external
"POSTGRES_PASSWORD": "str?", # Needed for postgresql_external
"POSTGRES_DB": "str?" # Needed for postgresql_external
```
## Installation
The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install this add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
## Support
If you have in issue with your installation, please be sure to checkout github.
## Screenshot
![image](https://github.com/TandoorRecipes/recipes/raw/develop/docs/preview.png)
[repository]: https://github.com/alexbelgium/hassio-addons
[smb-shield]: https://img.shields.io/badge/smb-yes-green.svg
[openvpn-shield]: https://img.shields.io/badge/openvpn-yes-green.svg
[ingress-shield]: https://img.shields.io/badge/ingress-yes-green.svg
[ssl-shield]: https://img.shields.io/badge/ssl-yes-green.svg
[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