mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-03-07 21:58:21 +01:00
8a0f15413c
Add the "Add repository to my Home Assistant" blue button to all addon README files that were missing it. This makes it easier for new HA users to add the repository with a single click. Updated 59 addon READMEs: - 51 with standard Installation section format - 8 with non-standard or missing Installation sections Co-authored-by: alexbelgium <44178713+alexbelgium@users.noreply.github.com>
157 lines
7.6 KiB
Markdown
157 lines
7.6 KiB
Markdown
# Hass.io Add-ons: Mealie
|
|
|
|
|
|
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
|
|
|
|
Warning : armv7 only supported up to version 0.4.3! It won't be updated with later versions
|
|
|
|
_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
|
|
|
|
Mealie is a self hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family.
|
|
This addon for mealie 1.0 is based on the combined [docker image](https://hub.docker.com/r/hendrix04/mealie-combined) from hendrix04.
|
|
This addon is based on the [docker image](https://hub.docker.com/r/hkotel/mealie) from hay-kot.
|
|
|
|
## Configuration
|
|
|
|
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.
|
|
|
|
- Start the addon. Wait a while and check the log for any errors.
|
|
- Default credentials:
|
|
- Username: changeme@example.com
|
|
- Password: MyPassword
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `PGID` | int | `1000` | Group ID for file permissions |
|
|
| `PUID` | int | `1000` | User ID for file permissions |
|
|
| `ssl` | bool | `false` | Enable HTTPS for the web interface |
|
|
| `certfile` | str | `fullchain.pem` | SSL certificate file (must be in /ssl) |
|
|
| `keyfile` | str | `privkey.pem` | SSL key file (must be in /ssl) |
|
|
| `BASE_URL` | str | | Optional external base URL |
|
|
| `DATA_DIR` | str | `/config` | Data directory path |
|
|
| `ALLOW_SIGNUP` | bool | `true` | Allow new user signup |
|
|
|
|
To configure Gunicorn's `--forwarded-allow-ips` setting for trusted reverse proxies, manually add a `FORWARDED_ALLOW_IPS` entry to your add-on configuration (comma-separated IPs). It is optional and hidden from the default options tab. For example: `FORWARDED_ALLOW_IPS: "192.168.1.1,10.0.0.1"`
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
PGID: 1000
|
|
PUID: 1000
|
|
ssl: false
|
|
certfile: "fullchain.pem"
|
|
keyfile: "privkey.pem"
|
|
BASE_URL: "https://mealie.mydomain.com"
|
|
DATA_DIR: "/config"
|
|
ALLOW_SIGNUP: false
|
|
```
|
|
|
|
### Custom Scripts and Environment Variables
|
|
|
|
This addon supports custom scripts and environment variables through the `addon_config` mapping:
|
|
|
|
- **Custom scripts**: See [Running Custom Scripts in Addons](https://github.com/alexbelgium/hassio-addons/wiki/Running-custom-scripts-in-Addons)
|
|
- **env_vars option**: 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.
|
|
|
|
You can add environment variables by creating `/homeassistant/addons_config/xxx-mealie/config.yaml`.
|
|
|
|
The complete list of options can be found here: https://nightly.mealie.io/documentation/getting-started/installation/backend-config/
|
|
|
|
## Integration with HA
|
|
|
|
### Detailed infos (Thanks @michelangelonz)
|
|
|
|
Create a restful sensor
|
|
|
|
```yaml
|
|
sensor:
|
|
- platform: rest
|
|
resource: "http://###.###.#.#:9090/api/groups/mealplans/today"
|
|
method: GET
|
|
name: Mealie todays meal
|
|
headers:
|
|
Authorization: Bearer <put auth here>
|
|
value_template: "{{ value_json.value }}"
|
|
json_attributes_path: $..recipe
|
|
json_attributes:
|
|
- name
|
|
- id
|
|
- totalTime
|
|
- prepTime
|
|
- performTime
|
|
- description
|
|
- slug
|
|
```
|
|
|
|
Create template sensors from attributes
|
|
|
|
```yaml
|
|
- name: TodaysDinner
|
|
unique_id: sensor.TodaysDinner
|
|
state: "{{ state_attr('sensor.mealie_todays_meal', 'name') }}"
|
|
- name: TodaysDinnerDescription
|
|
unique_id: sensor.DinnerDescription
|
|
state: "{{ state_attr('sensor.mealie_todays_meal', 'description') }}"
|
|
- name: TodaysDinnerSlug
|
|
unique_id: sensor.DinnerSlug
|
|
state: "{{ state_attr('sensor.mealie_todays_meal', 'slug') }}"
|
|
- name: TodaysDinnerID
|
|
unique_id: sensor.DinnerID
|
|
state: "{{ state_attr('sensor.mealie_todays_meal', 'id') }}"
|
|
```
|
|
|
|
Add a generic camera for image
|
|
http://###.###.#.#:9090/api/media/recipes/{{ state_attr('sensor.mealie_todays_meal', 'id') }}/images/min-original.webp
|
|
|
|
### Global infos
|
|
|
|
Read here : https://hay-kot.github.io/mealie/documentation/community-guide/home-assistant/
|
|
|
|
## 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 add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
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.
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|