mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
107 lines
6.3 KiB
Markdown
107 lines
6.3 KiB
Markdown
# Hass.io Add-ons: Tandoor recipes
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
[Tandoor recipes](https://github.com/TandoorRecipes/recipes), made by [vabene1111](https://github.com/vabene1111) 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
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
Webui can be found at <http://homeassistant:PORT> or through the sidebar using Ingress.
|
|
Configurations can be done through the app webUI, except for the following options.
|
|
|
|
For Ingress support, see: https://community.home-assistant.io/t/ingress-access-for-tandoor-recipes/717859
|
|
Complete documentation: https://docs.tandoor.dev/install/docker/
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `SECRET_KEY` | str | `YOUR_SECRET_KEY` | **REQUIRED**: Django secret key for security |
|
|
| `ALLOWED_HOSTS` | str | | **REQUIRED**: Comma-separated Home Assistant URLs for ingress |
|
|
| `DB_TYPE` | list | `sqlite` | Database type (sqlite or postgresql_external) |
|
|
| `DEBUG` | list | `0` | Debug mode (0=normal, 1=debug) |
|
|
| `externalfiles_folder` | str | | Folder for external recipe file imports |
|
|
| `POSTGRES_HOST` | str | | PostgreSQL host (required for postgresql_external) |
|
|
| `POSTGRES_PORT` | str | | PostgreSQL port (required for postgresql_external) |
|
|
| `POSTGRES_USER` | str | | PostgreSQL username (required for postgresql_external) |
|
|
| `POSTGRES_PASSWORD` | str | | PostgreSQL password (required for postgresql_external) |
|
|
| `POSTGRES_DB` | str | | PostgreSQL database name (required for postgresql_external) |
|
|
| `AI_MODEL_NAME` | str | | Used for configuring LLMs, supported providers can be found [here](https://docs.litellm.ai/docs/providers/) |
|
|
| `AI_API_KEY` | str | | API key for accessing LLMs |
|
|
| `AI_RATELIMIT` | str | | Ratelimit for LLM access, specified with [DRF syntax](https://www.django-rest-framework.org/api-guide/throttling/) |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
SECRET_KEY: "your-very-long-secret-key-here"
|
|
ALLOWED_HOSTS: "homeassistant.local,192.168.1.100"
|
|
DB_TYPE: "sqlite"
|
|
DEBUG: "0"
|
|
externalfiles_folder: "/config/addons_config/tandoor_recipes/externalfiles"
|
|
# For external PostgreSQL:
|
|
# POSTGRES_HOST: "core-postgres"
|
|
# POSTGRES_PORT: "5432"
|
|
# POSTGRES_USER: "tandoor"
|
|
# POSTGRES_PASSWORD: "secure_password"
|
|
# POSTGRES_DB: "tandoor_recipes"
|
|
# AI_MODEL_NAME: "anthropic/claude-4"
|
|
# AI_API_KEY: "SECRET KEY"
|
|
```
|
|
|
|
## 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
|
|
|
|
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
## External Recipe files
|
|
The directory /config/addons_config/tandoor_recipes/externalfiles can be used for importing external files in to Tandoor. You can map this with /opt/recipes/externalfiles within Docker.
|
|
As per directions here: https://docs.tandoor.dev/features/external_recipes/
|
|
|
|
|