feature/multi-tenancy and move caddy server (#980)

* update to GUIDs * fix cookbook id relationships * update webhook keys * cleanup naming and attribute orders * remove old database tables * fix meal-plan images * remove dashbaord and events api * use recipe-id instead of id * cleanup documentation assets * cleanup docs for v1 beta-release * add depends_on for docker-compose * use docker volumes for examples * move caddy to frontend container
2026-01-13 20:41:24 -05:00 · 2022-02-20 14:17:51 -09:00
parent 14cc541f7a
commit 602f248541
91 changed files with 187 additions and 1170 deletions
--- a/docs/docs/documentation/getting-started/api-usage.md
+++ b/docs/docs/documentation/getting-started/api-usage.md
@@ -15,4 +15,3 @@ Recipes extras are a key feature of the Mealie API. They allow you to create cus

 For example you could add `{"message": "Remember to thaw the chicken"}` to a recipe and use the webhooks built into mealie to send that message payload to a destination to be processed.

-![api-extras-gif](../../assets/gifs/api-extras.gif)
--- a/docs/docs/documentation/getting-started/installation/postgres.md
+++ b/docs/docs/documentation/getting-started/installation/postgres.md
@@ -14,6 +14,8 @@ services:
  mealie-frontend:
    image: hkotel/mealie:frontend-nightly
    container_name: mealie-frontend
+    depends_on:
+      - mealie-api
    environment:
    # Set Frontend ENV Variables Here
      - ALLOW_SIGNUP=true
@@ -21,11 +23,15 @@ services:
    restart: always
    ports:
      - "9925:3000"
+    volumes:
+      - mealie-data:/app/data/      
  mealie-api:
    image: hkotel/mealie:api-nightly
    container_name: mealie-api
+    depends_on:
+      - postgres
    volumes:
-      - ./data/:/app/data
+      - mealie-data:/app/data/
    environment:
    # Set Backend ENV Variables Here
      - PUID=1000
@@ -33,7 +39,7 @@ services:
      - TZ=America/Anchorage
      - MAX_WORKERS=1
      - WEB_CONCURRENCY=1
-      - BASE_URL=https://beta.mealie.io
+      - BASE_URL=https://mealie.yourdomain.com

    # Database Settings
      - DB_ENGINE=postgres
@@ -50,5 +56,9 @@ services:
    environment:
      POSTGRES_PASSWORD: mealie
      POSTGRES_USER: mealie
+
+volumes:
+  mealie-data:
+    driver: local
 ```

--- a/docs/docs/documentation/getting-started/installation/sqlite.md
+++ b/docs/docs/documentation/getting-started/installation/sqlite.md
@@ -21,11 +21,13 @@ services:
    restart: always
    ports:
      - "9925:3000"
+    volumes:
+      - mealie-data:/app/data/
  mealie-api:
    image: hkotel/mealie:api-nightly
    container_name: mealie-api
    volumes:
-      - ./data/:/app/data
+      - mealie-data:/app/data/
    environment:
    # Set Backend ENV Variables Here
      - PUID=1000
@@ -33,6 +35,10 @@ services:
      - TZ=America/Anchorage
      - MAX_WORKERS=1
      - WEB_CONCURRENCY=1
-      - BASE_URL=https://beta.mealie.io
+      - BASE_URL=https://mealie.yourdomain.com
    restart: always
+
+volumes:
+  mealie-data:
+    driver: local
 ```
--- a/docs/docs/documentation/getting-started/introduction.md
+++ b/docs/docs/documentation/getting-started/introduction.md
@@ -1,14 +1,18 @@
 # About The Project

+!!! warning "Mealie v1 Beta Release"
+    This documentation if for the Mealie v1 Beta release and is not final. As such, it may contain incomplete or incorrect information. You should understand that installing Mealie v1 Beta is a work in progress and while we've committed to maintaining the database schema and provided migrations, we are still in the process of adding new features, and robust testing to ensure the application works as expected.
+
+    You should likely find bugs, errors, and unfinished pages within the application. To find the current status of the release you can checkout the [project on github](https://github.com/hay-kot/mealie/projects/7) or reach out on discord.
+
+    You should also be aware that Mealie v1 Beta does not have the backup/export feature available. This is the next priority for Mealie v1
+    and is currently being worked out. 
+
 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. Easily add recipes into your database by providing the url and Mealie will automatically import the relevant data or add a family recipe with the UI editor. Mealie also provides an API for interactions from 3rd party applications. 

 [Remember to join the Discord](https://discord.gg/QuStdQGSGK)

-!!! note
-    In some of the demo gifs the styling may be different than the finale application. demos were done during development prior to finale styling.

-!!! warning
-    This is a **BETA** release and that means things may break and or change down the line. I'll do my best to make sure that any API changes are thoughtful and necessary in order not to break things. Additionally, I'll do my best to provide a migration path if the database schema ever changes. Do not use programs like watchtower to auto update your container. You **WILL** run into issues if you do this!


 ## Key Features
--- a/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md
+++ b/docs/docs/documentation/getting-started/migrating-to-mealie-v1.md
@@ -0,0 +1,39 @@
+# Migrating to Mealie v1 Release
+
+The version 1 release of Mealie should be seen as an entirely different application. A whole host of changes have been made to improve the application, performance, and developer experience. Most of these improvements required significant breaking changes in the application that made a clean and easy migration impossible. However, if you've used Mealie prior to v1 there is a migration path to get most of your data from the old version to the new v1 version. 
+
+!!! info "Currently Supported Migration Data"
+    Supporting more data is a work in progress, but not a current priority. I'm open to PR's to add support for additional data.
+
+    - [x] Recipes
+    - [x] Categories
+    - [x] Tags
+    - [ ] Users
+    - [ ] Groups
+    - [ ] Meal Plans
+    - [ ] Cookbooks / Pages
+
+## Step 1: Setting Up The New Application
+
+Given the nature of the upgrade, it is highly recommended that you standup a new instance of mealie along side your current instance. This will allow you to migrate your data safely and quickly without any issues. Follow the instructions in the [Installation Checklist](../getting-started/installation/installation-checklist.md) to get started. Once that's complete and you can login, continue here with step 2.
+
+## Step 2: Exporting Your Data from Pre-v1
+
+In your instance of Mealie prior to v1, perform an export of your data in the Admin section. Be sure to include the recipes when performing the export. Checking additional items won't impact the migration, but they will be ignored if they are included. 
+
+
+## Step 3: Using the Migration Tool
+
+In your new v1 instance, navigate to `/user/group/data/migrations` and select "Mealie" from the dropdown selector. Upload the exported data from your pre-v1 instance. Optionally, you can tag all the recipes you've imported with the `mealie_alpha` tag to help you identify them. Once the upload has finished, submit the form and your migration will begin. This may take some time, but when it's complete you'll be provided a new entry in hte "Previous Migrations" table below. Be sure to review the migration report to make sure everything was successful. There may be instances where some of the recipes were not imported, but the migration will still import all the successful recipes.
+
+In most cases, it's faster to manually migrate the recipes that didn't take instead of trying to identify why the recipes failed to import. If you're experiencing issues with the migration tool, please open an issue on GitHub.
+
+!!! note "Recipe Owners"
+    When perform any migration, it will automatically assign the owner of the recipe to the user that performed the migration. All group members will still be able to access the recipe, however the owner has special permissions to lock the recipe from edits from other users.
+
+
+## Step 4: Reviewing New Features
+
+v1 Comes with a whole host of new features and improvements. Checkout the changelog to get a sense for what's new. 
+
+- [v1 Changelog](../../changelog/v1.0.0.md)
--- a/docs/docs/documentation/getting-started/roadmap.md
+++ b/docs/docs/documentation/getting-started/roadmap.md
@@ -0,0 +1,7 @@
+# Development Road Map
+
+## Feature Requests
+See the [Github META issue for tracking feature requests](https://github.com/hay-kot/mealie/issues/122)
+
+## Progress 
+See the [Github Projects](https://github.com/hay-kot/mealie/projects) to see what is currently being worked on