From b7c283cc7d522dc3b28385c86a32862ed9eea4da Mon Sep 17 00:00:00 2001 From: Chip Date: Mon, 6 Jan 2025 16:04:10 -0500 Subject: [PATCH 1/8] Update backups-and-restoring.md - Adding notes regarding the Settings > Backup page in addition to the URL - Listed out some additional actions that can be performed in this page. Added a tip for manual review / adjustment of the database.json file in the event that a restore fails - Changed some verbiage (removing pluralization on some items) --- .../usage/backups-and-restoring.md | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/docs/documentation/getting-started/usage/backups-and-restoring.md b/docs/docs/documentation/getting-started/usage/backups-and-restoring.md index 84b9317b2f7..830e06c18ae 100644 --- a/docs/docs/documentation/getting-started/usage/backups-and-restoring.md +++ b/docs/docs/documentation/getting-started/usage/backups-and-restoring.md @@ -1,17 +1,24 @@ -# Backups and Restoring +# Backups and Restores -Mealie provides an integrated mechanics for doing full installation backups of the database. Navigate to `/admin/backups` to +Mealie provides an integrated mechanic for doing full installation backups of the database. + +Navigate to Settings > Backups or manually by adding `/admin/backups` to your instance URL. + +From this page, you will be able to: - See a list of available backups -- Perform a backups -- Restore a backup +- Create a backup +- Upload a backup +- Delete a backup (Confirmation Required) +- Download a backup +- Perform a restore !!! tip If you're using Mealie with SQLite all your data is stored in the /app/data/ folder in the container. You can easily perform entire site backups by stopping the container, and backing up this folder with your chosen tool. This is the **best** way to backup your data. ## Restoring from a Backup -To restore from a backup it needs to be uploaded to your instance, this can be done through the web portal. On the lower left hand corner of the backups data table you'll see an upload button. Click this button and select the backup file you want to upload and it will be available to import shortly. +To restore from a backup it needs to be uploaded to your instance which can be done through the web portal. On the top left of the page you'll see an upload button. Click this button and select the backup file you want to upload and it will be available to import shortly. You can alternatively use one of the backups you see on the screen, if one exists. Before importing it's critical that you understand the following: @@ -22,6 +29,10 @@ Before importing it's critical that you understand the following: !!! warning Prior to beta-v5 using a mis-matched version of the database backup will result in an error that will prevent you from using the instance of Mealie requiring you to remove all data and reinstall. Post beta-v5 performing a mismatched restore will throw an error and alert the user of the issue. +!!! tip + If for some reason the restore does not succeed, you can review the logs of what the issue may be, download the backup .ZIP and edit the contents of database.json to potentially resolve the issue. For example, if you receive an error restoring 'shopping-list' you can edit out the contents of that list while allowing other sections to restore. If you would like any assistance on this, reach out over Discord. + + ### Postgres Note Restoring the Database when using Postgres requires Mealie to be configured with a postgres **superuser** account. This is due to our usage of massive deleting of data in the database and temporarily setting roles to perform the restore. To perform a restoration on Postgres you will need to _temporarily_ set the Mealie user to a superuser account. From 4fcc8147ad034bf4cf7ff8618646da9c2bd6b0bd Mon Sep 17 00:00:00 2001 From: Chip Date: Tue, 7 Jan 2025 07:44:18 -0500 Subject: [PATCH 2/8] Add additional information and tips to Backup & Restore Usage - Adding notes regarding how to access via the Settings > Backup page in addition to the URL slug. - Location of 'backup button' changed from bottom left to top left - Listed out some additional actions that can be performed in this page. - Added a tip for manual review / adjustment of the database.json file in the event that a restore fails - Changed some verbiage (removing pluralization on some items) --- .../getting-started/usage/backups-and-restoring.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/docs/documentation/getting-started/usage/backups-and-restoring.md b/docs/docs/documentation/getting-started/usage/backups-and-restoring.md index 830e06c18ae..7f10ea78653 100644 --- a/docs/docs/documentation/getting-started/usage/backups-and-restoring.md +++ b/docs/docs/documentation/getting-started/usage/backups-and-restoring.md @@ -26,12 +26,11 @@ Before importing it's critical that you understand the following: - This action cannot be undone - If this action is successful you will be logged out and you will need to log back in to complete the restore -!!! warning - Prior to beta-v5 using a mis-matched version of the database backup will result in an error that will prevent you from using the instance of Mealie requiring you to remove all data and reinstall. Post beta-v5 performing a mismatched restore will throw an error and alert the user of the issue. - !!! tip If for some reason the restore does not succeed, you can review the logs of what the issue may be, download the backup .ZIP and edit the contents of database.json to potentially resolve the issue. For example, if you receive an error restoring 'shopping-list' you can edit out the contents of that list while allowing other sections to restore. If you would like any assistance on this, reach out over Discord. +!!! warning + Prior to beta-v5 using a mis-matched version of the database backup will result in an error that will prevent you from using the instance of Mealie requiring you to remove all data and reinstall. Post beta-v5 performing a mismatched restore will throw an error and alert the user of the issue. ### Postgres Note From ce4260bb83c95ef79c4255b2320a5ceaedaf10e1 Mon Sep 17 00:00:00 2001 From: Chip Date: Tue, 7 Jan 2025 08:08:28 -0500 Subject: [PATCH 3/8] Update Shopping Lists to include additional actions able to be performed, tips, and some examples. - Added location of Shopping Lists from Sidebar. - Added some common things that can be done (See added items, see linked recipes, checking off an item, sorting items, creating / sorting labels. - Added tip for unchecking a checked of item - Added tip for using 'Food' / 'Smart Handling' to combine ingredients - Added tip for using Labels to sort (however you may want) --- .../documentation/getting-started/features.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index 8e4aa62581c..5db2858bb05 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -84,7 +84,27 @@ The meal planner has the concept of plan rules. These offer a flexible way to us The shopping lists feature is a great way to keep track of what you need to buy for your next meal. You can add items directly to the shopping list or link a recipe and all of it's ingredients to track meals during the week. +Managing shopping lists can be done from the Sidebar > Shopping Lists. + +Here you will be able to: +- See list of already added items to the Shopping List +- See linked recipes with ingredients + - Toggling via the 'Pot' icon will show you the linked recipe, allowing you to click to access it. +- Check off an item +- Add / Change / Remove / Sort Items via the '3x3' grid icon + - Be sure if you are modifying an ingredient to click the 'Save' icon. +- Add / Change / Remove / Sort Labels + - 'No Label' will always be on the top, others can be Reordered via the 'Reorder Labels' button +!!! tip + If you accidently checked off an item, you can uncheck it by expanding 'items checked' and unchecking it. This will automatically add it back to the Shopping List. + +!!! tip + Along with Smart Handling, you can toggle 'Food' on individual items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'apple' icon. If you added "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese" Please note this cannot be undone once items are combined. + +!!! tip + You can use Labels to categorize your ingredients. You may want to Label by Food Type (Frozen, Fresh, etc), by Store, Tool, Recipe, or more. Play around with this to see what works best for you. + [Shopping List Demo](https://demo.mealie.io/shopping-lists){ .md-button .md-button--primary } ## Integrations From 0d82fd2808d73b52d04c91be2c1d18caab145966 Mon Sep 17 00:00:00 2001 From: Chip Date: Sun, 12 Jan 2025 09:26:50 -0500 Subject: [PATCH 4/8] Simplify Language for Items on Shopping List I agree with the changes to make this read better. Co-authored-by: boc-the-git <3479092+boc-the-git@users.noreply.github.com> --- docs/docs/documentation/getting-started/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index 5db2858bb05..3b1c68e956c 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -87,7 +87,7 @@ The shopping lists feature is a great way to keep track of what you need to buy Managing shopping lists can be done from the Sidebar > Shopping Lists. Here you will be able to: -- See list of already added items to the Shopping List +- See items already on the Shopping List - See linked recipes with ingredients - Toggling via the 'Pot' icon will show you the linked recipe, allowing you to click to access it. - Check off an item From 02fedb23c5d90ef83c3b6693c78eba0883aae423 Mon Sep 17 00:00:00 2001 From: Chip Date: Sun, 12 Jan 2025 09:27:45 -0500 Subject: [PATCH 5/8] Update Features for 'Unchecking' Shopping List Items Accepted suggestion for how 'Unchecking' an item is handled. Co-authored-by: boc-the-git <3479092+boc-the-git@users.noreply.github.com> --- docs/docs/documentation/getting-started/features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index 3b1c68e956c..c3fd22ca8c6 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -97,7 +97,7 @@ Here you will be able to: - 'No Label' will always be on the top, others can be Reordered via the 'Reorder Labels' button !!! tip - If you accidently checked off an item, you can uncheck it by expanding 'items checked' and unchecking it. This will automatically add it back to the Shopping List. + If you accidentally checked off an item, you can uncheck it by expanding 'items checked' and unchecking it. This will add it back to the Shopping List. !!! tip Along with Smart Handling, you can toggle 'Food' on individual items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'apple' icon. If you added "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese" Please note this cannot be undone once items are combined. From 5fd8810aea0ce87016208aa5c7f5d2447d4aec9c Mon Sep 17 00:00:00 2001 From: Chip Date: Sun, 12 Jan 2025 09:50:44 -0500 Subject: [PATCH 6/8] Making Suggested Changes from PR - Changed language as per suggestions: https://github.com/mealie-recipes/mealie/pull/4843 - Moved around some of the tips that were added - Added a note on using a 'Want to Make' tag under Cookbooks as per a discord conversation with Michael (great tip!) --- .../documentation/getting-started/features.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index c3fd22ca8c6..e7cf50f54a5 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -35,7 +35,7 @@ Mealie has a robust and flexible recipe organization system with a few different #### Categories -Categories are the overarching organizer for recipes. You can assign as many categories as you'd like to a recipe, but we recommend that you try to limit the categories you assign to a recipe to one or two. This helps keep categories as focused as possible while still allowing you to find recipes that are related to each other. For example, you might assign a recipe to the category **Breakfast**, **Lunch**, **Dinner**, or **Side**. +Categories are the overarching organizer for recipes. You can assign as many categories as you'd like to a recipe, but we recommend that you try to limit the categories you assign to a recipe to one or two. This helps keep categories as focused as possible while still allowing you to find recipes that are related to each other. For example, you might assign a recipe to the category **Breakfast**, **Lunch**, **Dinner**, **Side**, or **Drinks**. [Categories Demo](https://demo.mealie.io/g/home/recipes/categories){ .md-button .md-button--primary } @@ -62,6 +62,7 @@ Mealie also has the concept of cookbooks. These can be created inside of a group - Main Courses: This cookbooks has all the recipes that have the **Dinner** category - Pasta Sides: Recipes that have both the **Side** category and the **Pasta** tag - Dessert Breads: Recipes that have both the **Bread** category and the **Dessert** tag +- Make Later: Recipes that have a **Want To Make** tag [Cookbooks Demo](https://demo.mealie.io/g/home/cookbooks){ .md-button .md-button--primary } @@ -91,20 +92,23 @@ Here you will be able to: - See linked recipes with ingredients - Toggling via the 'Pot' icon will show you the linked recipe, allowing you to click to access it. - Check off an item -- Add / Change / Remove / Sort Items via the '3x3' grid icon +- Add / Change / Remove / Sort Items via the grid icon (![image](https://github.com/user-attachments/assets/ad59a5ea-2ee5-4c6c-9002-9312f018290f)) - Be sure if you are modifying an ingredient to click the 'Save' icon. - Add / Change / Remove / Sort Labels - 'No Label' will always be on the top, others can be Reordered via the 'Reorder Labels' button !!! tip If you accidentally checked off an item, you can uncheck it by expanding 'items checked' and unchecking it. This will add it back to the Shopping List. - -!!! tip - Along with Smart Handling, you can toggle 'Food' on individual items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'apple' icon. If you added "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese" Please note this cannot be undone once items are combined. !!! tip You can use Labels to categorize your ingredients. You may want to Label by Food Type (Frozen, Fresh, etc), by Store, Tool, Recipe, or more. Play around with this to see what works best for you. +!!! tip + You can toggle 'Food' on items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'apple' icon (![image](https://github.com/user-attachments/assets/0925c88b-77aa-4446-8539-2ee436243e15)). If you then have recipes that contain "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese." + +[See FAQ for more information](../getting-started/faq.md) + + [Shopping List Demo](https://demo.mealie.io/shopping-lists){ .md-button .md-button--primary } ## Integrations @@ -114,9 +118,9 @@ Mealie is designed to integrate with many different external services. There are ### Notifiers Notifiers are event-driven notifications sent when specific actions are performed within Mealie. Some actions include: -- creating a recipe -- adding items to a shopping list -- creating a new mealplan +- Creating / Updating a recipe +- Adding items to a shopping list +- Creating a new mealplan Notifiers use the [Apprise library](https://github.com/caronc/apprise/wiki), which integrates with a large number of notification services. In addition, certain custom notifiers send basic event data to the consumer (e.g. the `id` of the resource). These include: From 3b9c402d916c6626dce4a4e0a82734bee8e39bf6 Mon Sep 17 00:00:00 2001 From: Chip Date: Mon, 13 Jan 2025 15:13:57 -0500 Subject: [PATCH 7/8] Removing Images / Updating Tip Indentation - Removed Images until I can determine the best way to upload them (or use the SVG files) - Fixed the 'four spaces' instead of using a Tab. --- docs/docs/documentation/getting-started/features.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index e7cf50f54a5..1230bb687da 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -92,7 +92,7 @@ Here you will be able to: - See linked recipes with ingredients - Toggling via the 'Pot' icon will show you the linked recipe, allowing you to click to access it. - Check off an item -- Add / Change / Remove / Sort Items via the grid icon (![image](https://github.com/user-attachments/assets/ad59a5ea-2ee5-4c6c-9002-9312f018290f)) +- Add / Change / Remove / Sort Items via the grid icon - Be sure if you are modifying an ingredient to click the 'Save' icon. - Add / Change / Remove / Sort Labels - 'No Label' will always be on the top, others can be Reordered via the 'Reorder Labels' button @@ -104,7 +104,7 @@ Here you will be able to: You can use Labels to categorize your ingredients. You may want to Label by Food Type (Frozen, Fresh, etc), by Store, Tool, Recipe, or more. Play around with this to see what works best for you. !!! tip - You can toggle 'Food' on items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'apple' icon (![image](https://github.com/user-attachments/assets/0925c88b-77aa-4446-8539-2ee436243e15)). If you then have recipes that contain "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese." + You can toggle 'Food' on items so that if you add multiple of the same food / ingredient, Mealie will automatically combine them together. Do this by editing an item in the Shopping List and clicking the 'Apple' icon. If you then have recipes that contain "1 | cup | cheese" and "2 | cup | cheese" this would be combined to show "3 cups of cheese." [See FAQ for more information](../getting-started/faq.md) From a30d2f14ca8ba7385ee751219eb1b91dcd94817b Mon Sep 17 00:00:00 2001 From: Chip Date: Thu, 23 Jan 2025 07:53:59 -0500 Subject: [PATCH 8/8] Remove 'Make It Later' Tag To avoid confusion / manual modifications, removing the note of "Make it Later' --- docs/docs/documentation/getting-started/features.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/documentation/getting-started/features.md b/docs/docs/documentation/getting-started/features.md index 1230bb687da..173fb8548df 100644 --- a/docs/docs/documentation/getting-started/features.md +++ b/docs/docs/documentation/getting-started/features.md @@ -62,7 +62,6 @@ Mealie also has the concept of cookbooks. These can be created inside of a group - Main Courses: This cookbooks has all the recipes that have the **Dinner** category - Pasta Sides: Recipes that have both the **Side** category and the **Pasta** tag - Dessert Breads: Recipes that have both the **Bread** category and the **Dessert** tag -- Make Later: Recipes that have a **Want To Make** tag [Cookbooks Demo](https://demo.mealie.io/g/home/cookbooks){ .md-button .md-button--primary }