From 7bbb4e0034f9e8d7e286ece3f929937d6830e6f4 Mon Sep 17 00:00:00 2001 From: Alexandre <44178713+alexbelgium@users.noreply.github.com> Date: Sat, 7 Jan 2023 18:21:21 +0100 Subject: [PATCH] Update README.md --- mealie/README.md | 87 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 69 insertions(+), 18 deletions(-) diff --git a/mealie/README.md b/mealie/README.md index 6a4e6b9b5..598b030aa 100644 --- a/mealie/README.md +++ b/mealie/README.md @@ -1,22 +1,73 @@ -## ⚠ Open Issue : [🐛 [Mealie] Server Error (opened 2023-01-04)](https://github.com/alexbelgium/hassio-addons/issues/629) by [@chicknlil](https://github.com/chicknlil) -Instructions to migrate to the 2 addons system below. -Please backup all your data, and migrate to the new addons with separate Frontend and API. +## Breaking change : no database migration with v1.0. Please backup your database from within Mealie before upgrading, then restore the database after upgrading. Infos here : https://hay-kot.github.io/mealie/documentation/getting-started/updating/. Something to note however about the database migration is that only the recipe data gets migrated. Not user data or other settings, and the favorite recipes are also no longer listed as such so they need to be selected again (Thanks @SeeThisIsMe) -## Migrating from <1.0 (aarch64) : +# Hass.io Add-ons: Mealie -1. Backup all your data from this addon -2. Install the Mealie API addon -3. Configure your base url if needed, and launch it -4. Install the Mealie Frontend addon -5. Configure the API endpoint (make sure to use the addon port of the API addon) -6. Login with the default passwords (Username: changeme@email.com, Password: MyPassword) -7. Import the database -8. Uninstall the previous addon +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) -## Migrating from >1.0 (amd64) (thanks @jdeath) : +![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%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%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%2Fconfig.json) -While you cannot update from >1.0 to the new version, you can move your database. -1. Start new API and front end addon. -2. Stop new API and front end addon -3. Start the old mealie addon, log in to the docker container, and cp -r /data/* /config/addons_config/mealie_data/ -4. Start new API and front end addon, and everything should be working +[![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 + +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!_ + + +[![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 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. + +## 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. +- Open yourdomain.com:9925 (where ":9925" is the port configured in the addon). +- Default + - Username: changeme@email.com + - Password: MyPassword + +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