diff --git a/docs/docs/documentation/community-guide/bring-api.md b/docs/docs/documentation/community-guide/bring-api.md index 41214bb0c..e545ffaeb 100644 --- a/docs/docs/documentation/community-guide/bring-api.md +++ b/docs/docs/documentation/community-guide/bring-api.md @@ -1,5 +1,5 @@ !!! info -This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! Mealie supports adding the ingredients of a recipe to your [Bring](https://www.getbring.com/) shopping list, as you can see [here](https://docs.mealie.io/documentation/getting-started/features/#recipe-actions). diff --git a/docs/docs/documentation/community-guide/home-assistant.md b/docs/docs/documentation/community-guide/home-assistant.md index e3a1c4dd0..5a47880a1 100644 --- a/docs/docs/documentation/community-guide/home-assistant.md +++ b/docs/docs/documentation/community-guide/home-assistant.md @@ -1,21 +1,21 @@ !!! info - This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! In a lot of ways, Home Assistant is why this project exists! Since Mealie has a robust API it makes it a great fit for interacting with Home Assistant and pulling information into your dashboard. -### Display Today's Meal in Lovelace +## Display Today's Meal in Lovelace You can use the Mealie API to get access to meal plans in Home Assistant like in the image below. ![api-extras-gif](../../assets/img/home-assistant-card.png) -Steps: +## Steps: -#### 1. Get your API Token +### 1. Get your API Token -Create an API token from Mealie's User Settings page (https://docs.mealie.io/documentation/getting-started/api-usage/#getting-a-token) +Create an API token from Mealie's User Settings page (see [this page](https://docs.mealie.io/documentation/getting-started/api-usage/#getting-a-token) to learn how). -#### 2. Create Home Assistant Sensors +### 2. Create Home Assistant Sensors Create REST sensors in home assistant to get the details of today's meal. We will create sensors to get the name and ID of the first meal in today's meal plan (note that this may not be what is wanted if there is more than one meal planned for the day). We need the ID as well as the name to be able to retrieve the image for the meal. @@ -40,7 +40,7 @@ rest: unique_id: mealie_todays_meal_id ``` -#### 3. Create a Camera Entity +### 3. Create a Camera Entity We will create a camera entity to display the image of today's meal in Lovelace. @@ -52,7 +52,7 @@ In the still image url field put in: Under the entity page for the new camera, rename it. e.g. `camera.mealie_todays_meal_image` -#### 4. Create a Lovelace Card +### 4. Create a Lovelace Card Create a picture entity card and set the entity to `mealie_todays_meal` and the camera entity to `camera.mealie_todays_meal_image` or set in the yaml directly. @@ -76,4 +76,4 @@ card_mod: ``` !!! tip -Due to how Home Assistant works with images, I had to include the additional styling to get the images to not appear distorted. This requires an [additional installation](https://github.com/thomasloven/lovelace-card-mod) from HACS. + Due to how Home Assistant works with images, I had to include the additional styling to get the images to not appear distorted. This requires an [additional installation](https://github.com/thomasloven/lovelace-card-mod) from HACS. diff --git a/docs/docs/documentation/community-guide/ios-shortcut.md b/docs/docs/documentation/community-guide/ios-shortcut.md index 400dab15d..62e52063f 100644 --- a/docs/docs/documentation/community-guide/ios-shortcut.md +++ b/docs/docs/documentation/community-guide/ios-shortcut.md @@ -1,9 +1,10 @@ !!! info - This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! An easy way to add recipes to Mealie from an Apple device is via an Apple Shortcut. This is a short guide to install an configure a shortcut able to add recipes via a link or image(s). -*Note: if adding via images make sure to enable [Mealie's openai integration](https://docs.mealie.io/documentation/getting-started/installation/open-ai/)* +!!! note + If adding via images make sure to enable [Mealie's OpenAI Integration](https://docs.mealie.io/documentation/getting-started/installation/open-ai/) ## Javascript can only be run via Shortcuts on the Safari browser on MacOS and iOS. If you do not use Safari you may skip this section Some sites have begun blocking AI scraping bots, inadvertently blocking the recipe scraping library Mealie uses as well. To circumvent this, the shortcut uses javascript to capture the raw html loaded in the browser and sends that to mealie when possible. @@ -16,12 +17,13 @@ Settings app -> apps -> Shortcuts -> Advanced -> Allow Running Scripts Shortcuts app -> Settings (CMD ,) -> Advanced -> Allow Running Scripts -## Initial setup +## Initial Setup An API key is needed to authenticate with mealie. To create an api key for a user, navigate to http://YOUR_MEALIE_URL/user/profile/api-tokens. Alternatively you can create a key via the mealie home page by clicking the user's profile pic in the top left -> Api Tokens The shortcut can be installed via **[This link](https://www.icloud.com/shortcuts/52834724050b42aebe0f2efd8d067360)**. Upon install, replace "MEALIE_API_KEY" with the API key generated previously and "MEALIE_URI" with the full URL used to access your mealie instance e.g. "http://10.0.0.5:9000" or "https://mealie.domain.com". -## Using the shortcut +## Using the Shortcut Once installed, the shortcut will automatically appear as an option when sharing an image or webpage. It can also be useful to add the shortcut to the home screen of your device. If selected from the home screen or shortcuts app, a menu will appear with prompts to import via **taking photo(s)**, **selecting photo(s)**, **scanning a URL**, or **pasting a URL**. -*Note: despite the mealie API being able to accept multiple recipe images for import it is currently impossible to send multiple files in 1 web request via Shortcuts. Instead, the shortcut combines the images into a singular, vertically-concatenated image to send to mealie. This can result in slightly less-accurate text recognition.* \ No newline at end of file +!!! note + Despite the Mealie API being able to accept multiple recipe images for import it is currently impossible to send multiple files in 1 web request via Shortcuts. Instead, the shortcut combines the images into a singular, vertically-concatenated image to send to mealie. This can result in slightly less-accurate text recognition. \ No newline at end of file diff --git a/docs/docs/documentation/community-guide/swag.md b/docs/docs/documentation/community-guide/swag.md index 1da92320d..f1c624299 100644 --- a/docs/docs/documentation/community-guide/swag.md +++ b/docs/docs/documentation/community-guide/swag.md @@ -1,11 +1,10 @@ # Using SWAG as Reverse Proxy !!! info - This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! + This guide was submitted by a community member. Find something wrong? Submit a PR to get it fixed! +To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag). - -To make the setup of a Reverse Proxy much easier, Linuxserver.io developed [SWAG](https://github.com/linuxserver/docker-swag) SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx web server and reverse proxy with PHP support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention. ## Step 1: Get a domain