diff --git a/mealie_api/README.md b/mealie_api/README.md index 27a2bb898..6638ce580 100644 --- a/mealie_api/README.md +++ b/mealie_api/README.md @@ -1,64 +1,5 @@ -# Hass.io Add-ons: Mealie API +# Obsolete -[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) +The dev has now published an all-in-one image! Therefore, I'm cancelling the separate api/frontend addons and moving back to the original one. It now comprises both API and frontend, and exposes both on different ports. -![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fmealie_api%2Fconfig.json) -![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fmealie_api%2Fconfig.json) -![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fmealie_api%2Fconfig.json) - -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](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) -[![GitHub Super-Linter](https://github.com/alexbelgium/hassio-addons/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) -[![Builder](https://github.com/alexbelgium/hassio-addons/workflows/Builder/badge.svg)](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml) - -[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&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!_ - -[![Stargazers repo roster for @alexbelgium/hassio-addons](https://git-lister.onrender.com/api/stars/alexbelgium/hassio-addons?limit=30)](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 is based on the [docker image](https://hub.docker.com/r/hkotel/mealie) from hay-kot. -This addon contains only the API, the frontend is installed with another addon. - -## 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. - -## Configuration - -- Start the addon. Wait a while and check the log for any errors. -- Install the Mealie Frontend Addon, configure it and start it - -Options can be configured through two ways : - -- Addon options - -```yaml -ssl: true/false -certfile: fullchain.pem #ssl certificate, must be located in /ssl -keyfile: privkey.pem #sslkeyfile, must be located in /ssl -``` - -- Config.yaml - Additional options can be configured using the config.yaml file found in /config/addons_config/mealie/config.yaml - -The complete list of options can be seen here : https://nightly.mealie.io/documentation/getting-started/installation/backend-config/ - -## Integration with HA - -Read here : https://hay-kot.github.io/mealie/documentation/community-guide/home-assistant/ - -## Support - -If you have in issue with your installation, please be sure to checkout github. - -[repository]: https://github.com/alexbelgium/hassio-addons +As before, you can export your database, log to the new addon, then reimport it. Perhaps it could work straight out of the box as the data path stays the same