diff --git a/docs/docs/changelog/v1.0.0.md b/docs/docs/changelog/v1.0.0.md index 6e114605..4310de28 100644 --- a/docs/docs/changelog/v1.0.0.md +++ b/docs/docs/changelog/v1.0.0.md @@ -5,7 +5,7 @@ !!! error "Breaking Changes" As you may have guessed, this release comes with some breaking changes. If you are/were consuming the API you will need to validate all endpoints as nearly all of them have changed. - To import your data into Mealie v1 from the most recent previous release, you'll need to export and import your data using the bult in method. **Note that only your recipes will be usable in the migration**. + To import your data into Mealie v1 from the most recent previous release, you'll need to export and import your data using the built in method. **Note that only your recipes will be usable in the migration**. ## โœจ What's New (What isn't?!?!) @@ -13,19 +13,22 @@ ### ๐Ÿฅณ General - Mealie will by default only be accessible to users. Future plans are to create spaces for non-users to access a specific group. - Mealie has gone through a big redesign and has tried to standardize it's look a feel a bit more across the board. -- User/Group settings are now completely seperated from the Administration page. +- User/Group settings are now completely separated from the Administration page. - All settings and configurations pages now have some sort of self-documenting help text. Additional text or descriptions are welcome from PRs +- Site settings now has status on whether or not some ENV variables have been configured correctly. ### ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Users and Groups - Recipes are now only viewable by group members - All members of a group can generate invitation tokens for other users to join their group -- Users now a have "Advaced" setting to enable/disable features like Webhooks and API tokens. This will also apply to future features that are deemed as advanced. +- Users now a have "Advanced" setting to enable/disable features like Webhooks and API tokens. This will also apply to future features that are deemed as advanced. - "Pages" have been dropped in favor of Cookbooks which are now group specific so each group can have it's own set of cookbooks - Default recipe settings can now be set by the group instead of environmental variables. - +- Password reset via email +- Invitation to group by email +- Manage group member permissions ### ๐Ÿ—“ Meal Plans -- Mealplans have been completely redesigned to use a calendar approach so you'll be able to see what meals you have planned in a more traditional view +- Meal plans have been completely redesigned to use a calendar approach so you'll be able to see what meals you have planned in a more traditional view - Drag and Drop meals between days - Add Recipes or Notes to a specific day @@ -41,7 +44,7 @@ ### ๐Ÿ‘จโ€๐Ÿ’ป Backend/Development Goodies -- Codebase is siginficantly more organized both Frontend and Backend +- Codebase is significantly more organized both Frontend and Backend - We've moved to Nuxt for SSR and Typescript for better type safety and less bugs ๐ŸŽ‰ - Backend now using a Class based architecture to maximize code reuse - Tons of performance improvements across the board diff --git a/docs/docs/documentation/getting-started/install.md b/docs/docs/documentation/getting-started/install.md deleted file mode 100644 index 3c2072c3..00000000 --- a/docs/docs/documentation/getting-started/install.md +++ /dev/null @@ -1,255 +0,0 @@ -# Installation - -To deploy mealie on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose below you should be able to get a stack up and running easily by changing a few default values and deploying. You can deploy with either SQLite (default) or Postgres. SQLite is sufficient for most use cases. Additionally, with mealies automated backup and restore functionality, you can easily move between SQLite and Postgres as you wish. - -[Get Docker](https://docs.docker.com/get-docker/) - -[Mealie on Dockerhub](https://hub.docker.com/r/hkotel/mealie) - -- linux/amd64 -- linux/arm64 - -## Quick Start - Docker CLI - -Deployment with the Docker CLI can be done with `docker run` and specify the database type, in this case `sqlite`, setting the exposed port `9925`, mounting the current directory, and pull the latest image. After the image is up and running you can navigate to http://your.ip.address:9925 and you'll should see mealie up and running! - -```shell -docker run \ - -p 9925:80 \ - -v `pwd`:'/app/data/' \ - hkotel/mealie:latest - -``` - -!!! tip "Default Credentials" - - **Username:** changeme@email.com - - **Password:** MyPassword - -## Docker Compose with SQLite - -Deployment with docker-compose is the recommended method for deployment. The example below will create an instance of mealie available on port `9925` with the data volume mounted from the local directory. To use, create a docker-compose.yml file, paste the contents below and save. In the terminal run `docker-compose up -d` to start the container. - -```yaml -version: "3.1" -services: - mealie: - container_name: mealie - image: hkotel/mealie:latest - restart: always - ports: - - 9925:80 - environment: - PUID: 1000 - PGID: 1000 - TZ: America/Anchorage - - # Gunicorn - WEB_CONCURRENCY: 2 - # WORKERS_PER_CORE: 0.5 - # MAX_WORKERS: 8 - volumes: - - ./mealie/data/:/app/data -``` - -## Docker Compose with Postgres _(BETA)_ - -Postgres support was introduced in v0.5.0. At this point it should be used with caution and frequent backups. - -```yaml -version: "3.1" -services: - mealie: - container_name: mealie - image: hkotel/mealie:latest - restart: always - ports: - - 9090:80 - depends_on: - - postgres - environment: - PUID: 1000 - PGID: 1000 - TZ: America/Anchorage - - # Database Settings - DB_ENGINE: postgres # Optional: 'sqlite', 'postgres' - POSTGRES_USER: mealie - POSTGRES_PASSWORD: mealie - POSTGRES_SERVER: postgres - POSTGRES_PORT: 5432 - POSTGRES_DB: mealie - - # Gunicorn - WEB_CONCURRENCY: 2 - # WORKERS_PER_CORE: 0.5 - # MAX_WORKERS: 8 - volumes: - - ./mealie/data/:/app/data - postgres: - container_name: postgres - image: postgres - restart: always - environment: - POSTGRES_PASSWORD: mealie - POSTGRES_USER: mealie -``` - -## API Environment Variables - -### General - -| Variables | Default | Description | -| ------------- | :-------------------: | ----------------------------------------------------------------------------------- | -| PUID | 911 | UserID permissions between host OS and container | -| PGID | 911 | GroupID permissions between host OS and container | -| DEFAULT_GROUP | Home | The default group for users | -| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser | -| BASE_URL | http://localhost:8080 | Used for Notifications | -| TOKEN_TIME | 2 | The time in hours that a login/auth token is valid | -| API_PORT | 9000 | The port exposed by backend API. **Do not change this if you're running in Docker** | -| API_DOCS | True | Turns on/off access to the API documentation locally. | -| TZ | UTC | Must be set to get correct date/time on the server | - - -### Database - -| Variables | Default | Description | -| ----------------- | :------: | -------------------------------- | -| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' | -| POSTGRES_USER | mealie | Postgres database user | -| POSTGRES_PASSWORD | mealie | Postgres database password | -| POSTGRES_SERVER | postgres | Postgres database server address | -| POSTGRES_PORT | 5432 | Postgres database port | -| POSTGRES_DB | mealie | Postgres database name | - -### Email - -| Variables | Default | Description | -| --------------- | :-----: | ------------------ | -| SMTP_HOST | None | Required For email | -| SMTP_PORT | 587 | Required For email | -| SMTP_FROM_NAME | Mealie | Required For email | -| SMTP_TLS | true | Required For email | -| SMTP_FROM_EMAIL | None | Required For email | -| SMTP_USER | None | Required For email | -| SMTP_PASSWORD | None | Required For email | - -### Webworkers -| Variables | Default | Description | -| ---------------- | :-----: | --------------------------------------------------------------------------------------------------------------------------------- | -| WORKERS_PER_CORE | 1 | Set the number of workers to the number of CPU cores multiplied by this value (Value \* CPUs). More info [here][workers_per_core] | -| MAX_WORKERS | | Set the maximum number of workers to use. Default is not set meaning unlimited. More info [here][max_workers] | -| WEB_CONCURRENCY | 2 | Override the automatic definition of number of workers. More info [here][web_concurrency] | - - -## Frontend Environment Variables - -### General - -| Variables | Default | Description | -| ------------ | :-----: | ---------------------------------- | -| ALLOW_SIGNUP | true | Allows anyone to signup for Mealie | - -## Themeing -| Variables | Default | Description | -| --------------------- | :-----: | --------------------------- | -| THEME_LIGHT_PRIMARY | #E58325 | Light Theme Config Variable | -| THEME_LIGHT_ACCENT | #007A99 | Light Theme Config Variable | -| THEME_LIGHT_SECONDARY | #973542 | Light Theme Config Variable | -| THEME_LIGHT_SUCCESS | #43A047 | Light Theme Config Variable | -| THEME_LIGHT_INFO | #1976D2 | Light Theme Config Variable | -| THEME_LIGHT_WARNING | #FF6D00 | Light Theme Config Variable | -| THEME_LIGHT_ERROR | #EF5350 | Light Theme Config Variable | -| DARK_LIGHT_PRIMARY | #E58325 | Dark Theme Config Variable | -| DARK_LIGHT_ACCENT | #007A99 | Dark Theme Config Variable | -| DARK_LIGHT_SECONDARY | #973542 | Dark Theme Config Variable | -| DARK_LIGHT_SUCCESS | #43A047 | Dark Theme Config Variable | -| DARK_LIGHT_INFO | #1976D2 | Dark Theme Config Variable | -| DARK_LIGHT_WARNING | #FF6D00 | Dark Theme Config Variable | -| DARK_LIGHT_ERROR | #EF5350 | Dark Theme Config Variable | - -## Raspberry Pi 4 - -!!! tip "Fatal Python error: init_interp_main: can't initialize time" - - Some users experience an problem with running the linux/arm/v7 container on Raspberry Pi 4. This is not a problem with the Mealie container, but with a bug in the hosts Docker installation. - - Update the host RP4 using [instructions](https://github.com/linuxserver/docker-papermerge/issues/4#issuecomment-735236388), summarized here: - - ```shell - wget http://ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.1-1_armhf.deb - sudo dpkg -i libseccomp2_2.5.1-1_armhf.deb - ``` - -## Advanced - -!!! warning "Not Required" - - The items below are completely optional and are not required to manage or install your Mealie instance. - -### Custom Caddy File - -The Docker image provided by Mealie contains both the API and the html bundle in one convenient image. This is done by using a proxy server to serve different parts of the application depending on the URL/URI. Requests sent to `/api/*` or `/docs` will be directed to the API, anything else will be served the static web files. Below is the default Caddyfile that is used to proxy requests. You can override this file by mounting an alternative Caddyfile to `/app/Caddyfile`. - -``` -{ - auto_https off - admin off -} - -:80 { - @proxied path /api/* /docs /openapi.json - - root * /app/dist - encode gzip - uri strip_suffix / - - handle_path /api/recipes/image/* { - root * /app/data/img/ - file_server - } - - handle @proxied { - reverse_proxy http://127.0.0.1:9000 - } - - handle { - try_files {path}.html {path} / - file_server - } -} -``` - -## Deployed without Docker - -!!! error "Unsupported Deployment" - - If you are experiencing a problem with manual deployment, please do not submit a github issue unless it is related to an aspect of the application. For deployment help, the [discord server](https://discord.gg/QuStdQGSGK) is a better place to find support. - -Alternatively, this project is built on Python and SQLite so you may run it as a python application on your server. This is not a supported options for deployment and is only here as a reference for those who would like to do this on their own. To get started you can clone this repository into a directory of your choice and use the instructions below as a reference for how to get started. - -There are three parts to the Mealie application - -- Frontend/Static Files -- Backend API -- Proxy Server - -### Frontend/ Static Files - -The frontend static files are generated with `npm run build`. This is done during the build process with docker. If you choose to deploy this as a system application you must do this process yourself. In the project directory run `cd frontend` to change directories into the frontend directory and run `npm install` and then `npm run build`. This will generate the static files in a `dist` folder in the frontend directory. - -### Backend API - -The backend API is build with Python, FastAPI, and SQLite and requires Python 3.9, and Poetry. Once the requirements are installed, in the project directory you can run the command `poetry install` to create a python virtual environment and install the python dependencies. - -Once the dependencies are installed you should be ready to run the server. To initialize that database you need to first run `python mealie/db/init_db.py`. Then to start The web server, you run the command `uvicorn mealie.app:app --host 0.0.0.0 --port 9000` - -### Proxy Server - -You must use a proxy server to server up the static files created with `npm run build` and proxy requests to the API. In the docker build this is done with Caddy. You can use the CaddyFile in the section above as a reference. One important thing to keep in mind is that you should drop any trailing `/` in the url. Not doing this may result in failed API requests. - -[workers_per_core]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#workers_per_core -[max_workers]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#max_workers -[web_concurrency]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#web_concurrency diff --git a/docs/docs/documentation/getting-started/installation/advanced.md b/docs/docs/documentation/getting-started/installation/advanced.md new file mode 100644 index 00000000..3c1c4d2d --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/advanced.md @@ -0,0 +1,70 @@ +# Advanced Installation + +!!! warning "Not Required" + + The items below are completely optional and are not required to manage or install your Mealie instance. + +### Custom Caddy File + +The Docker image provided by Mealie contains both the API and the html bundle in one convenient image. This is done by using a proxy server to serve different parts of the application depending on the URL/URI. Requests sent to `/api/*` or `/docs` will be directed to the API, anything else will be served the static web files. Below is the default Caddyfile that is used to proxy requests. You can override this file by mounting an alternative Caddyfile to `/app/Caddyfile`. + +``` +{ + auto_https off + admin off +} + +:80 { + @proxied path /api/* /docs /openapi.json + + root * /app/dist + encode gzip + uri strip_suffix / + + handle_path /api/recipes/image/* { + root * /app/data/img/ + file_server + } + + handle @proxied { + reverse_proxy http://127.0.0.1:9000 + } + + handle { + try_files {path}.html {path} / + file_server + } +} +``` + +## Deployed without Docker + +!!! error "Unsupported Deployment" + + If you are experiencing a problem with manual deployment, please do not submit a github issue unless it is related to an aspect of the application. For deployment help, the [discord server](https://discord.gg/QuStdQGSGK) is a better place to find support. + +Alternatively, this project is built on Python and SQLite so you may run it as a python application on your server. This is not a supported options for deployment and is only here as a reference for those who would like to do this on their own. To get started you can clone this repository into a directory of your choice and use the instructions below as a reference for how to get started. + +There are three parts to the Mealie application + +- Frontend/Static Files +- Backend API +- Proxy Server + +### Frontend/ Static Files + +The frontend static files are generated with `npm run build`. This is done during the build process with docker. If you choose to deploy this as a system application you must do this process yourself. In the project directory run `cd frontend` to change directories into the frontend directory and run `npm install` and then `npm run build`. This will generate the static files in a `dist` folder in the frontend directory. + +### Backend API + +The backend API is build with Python, FastAPI, and SQLite and requires Python 3.9, and Poetry. Once the requirements are installed, in the project directory you can run the command `poetry install` to create a python virtual environment and install the python dependencies. + +Once the dependencies are installed you should be ready to run the server. To initialize that database you need to first run `python mealie/db/init_db.py`. Then to start The web server, you run the command `uvicorn mealie.app:app --host 0.0.0.0 --port 9000` + +### Proxy Server + +You must use a proxy server to server up the static files created with `npm run build` and proxy requests to the API. In the docker build this is done with Caddy. You can use the CaddyFile in the section above as a reference. One important thing to keep in mind is that you should drop any trailing `/` in the url. Not doing this may result in failed API requests. + +[workers_per_core]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#workers_per_core +[max_workers]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#max_workers +[web_concurrency]: https://github.com/tiangolo/uvicorn-gunicorn-docker/blob/2daa3e3873c837d5781feb4ff6a40a89f791f81b/README.md#web_concurrency diff --git a/docs/docs/documentation/getting-started/installation/backend-config.md b/docs/docs/documentation/getting-started/installation/backend-config.md new file mode 100644 index 00000000..52550fd7 --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/backend-config.md @@ -0,0 +1,51 @@ +# Backend Configuration + +## API Environment Variables + +### General + +| Variables | Default | Description | +| ------------- | :-------------------: | ----------------------------------------------------------------------------------- | +| PUID | 911 | UserID permissions between host OS and container | +| PGID | 911 | GroupID permissions between host OS and container | +| DEFAULT_GROUP | Home | The default group for users | +| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser | +| BASE_URL | http://localhost:8080 | Used for Notifications | +| TOKEN_TIME | 48 | The time in hours that a login/auth token is valid | +| API_PORT | 9000 | The port exposed by backend API. **Do not change this if you're running in Docker** | +| API_DOCS | True | Turns on/off access to the API documentation locally. | +| TZ | UTC | Must be set to get correct date/time on the server | + + +### Database + +| Variables | Default | Description | +| ----------------- | :------: | -------------------------------- | +| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' | +| POSTGRES_USER | mealie | Postgres database user | +| POSTGRES_PASSWORD | mealie | Postgres database password | +| POSTGRES_SERVER | postgres | Postgres database server address | +| POSTGRES_PORT | 5432 | Postgres database port | +| POSTGRES_DB | mealie | Postgres database name | + + +### Email + +| Variables | Default | Description | +| --------------- | :-----: | ------------------ | +| SMTP_HOST | None | Required For email | +| SMTP_PORT | 587 | Required For email | +| SMTP_FROM_NAME | Mealie | Required For email | +| SMTP_TLS | true | Required For email | +| SMTP_FROM_EMAIL | None | Required For email | +| SMTP_USER | None | Required For email | +| SMTP_PASSWORD | None | Required For email | + +### Webworker +Changing the webworker settings may cause unforeseen memory leak issues with Mealie. It's best to leave these at the defaults unless you begin to experience issues with multiple users. Exercise caution when changing these settings + +| Variables | Default | Description | +| ---------------- | :-----: | --------------------------------------------------------------------------------------------------------------------------------- | +| WORKERS_PER_CORE | 1 | Set the number of workers to the number of CPU cores multiplied by this value (Value \* CPUs). More info [here][workers_per_core] | +| MAX_WORKERS | 1 | Set the maximum number of workers to use. Default is not set meaning unlimited. More info [here][max_workers] | +| WEB_CONCURRENCY | 1 | Override the automatic definition of number of workers. More info [here][web_concurrency] | diff --git a/docs/docs/documentation/getting-started/installation/frontend-config.md b/docs/docs/documentation/getting-started/installation/frontend-config.md new file mode 100644 index 00000000..f735efdd --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/frontend-config.md @@ -0,0 +1,30 @@ +# Frontend Configuration + +## Environment Variables + +### General + +| Variables | Default | Description | +| ------------ | :--------------------: | ----------------------------------- | +| ALLOW_SIGNUP | true | Allows anyone to sign-up for Mealie | +| API_URL | http://mealie-api:9000 | URL to proxy API requests | + +### Themeing +Setting the following environmental variables will change the theme of the frontend. Note that the themes are the same for all users. This is a break-change when migration from v0.x.x -> 1.x.x. + +| Variables | Default | Description | +| --------------------- | :-----: | --------------------------- | +| THEME_LIGHT_PRIMARY | #E58325 | Light Theme Config Variable | +| THEME_LIGHT_ACCENT | #007A99 | Light Theme Config Variable | +| THEME_LIGHT_SECONDARY | #973542 | Light Theme Config Variable | +| THEME_LIGHT_SUCCESS | #43A047 | Light Theme Config Variable | +| THEME_LIGHT_INFO | #1976D2 | Light Theme Config Variable | +| THEME_LIGHT_WARNING | #FF6D00 | Light Theme Config Variable | +| THEME_LIGHT_ERROR | #EF5350 | Light Theme Config Variable | +| DARK_LIGHT_PRIMARY | #E58325 | Dark Theme Config Variable | +| DARK_LIGHT_ACCENT | #007A99 | Dark Theme Config Variable | +| DARK_LIGHT_SECONDARY | #973542 | Dark Theme Config Variable | +| DARK_LIGHT_SUCCESS | #43A047 | Dark Theme Config Variable | +| DARK_LIGHT_INFO | #1976D2 | Dark Theme Config Variable | +| DARK_LIGHT_WARNING | #FF6D00 | Dark Theme Config Variable | +| DARK_LIGHT_ERROR | #EF5350 | Dark Theme Config Variable | diff --git a/docs/docs/documentation/getting-started/installation/installation-checklist.md b/docs/docs/documentation/getting-started/installation/installation-checklist.md new file mode 100644 index 00000000..cfef45de --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/installation-checklist.md @@ -0,0 +1,53 @@ +# Installation Checklist + +To install Mealie on your server there are a few steps for proper configuration. Let's go through them. + +## Step 0: Pre-work + +To deploy mealie on your local network it is highly recommended to use docker to deploy the image straight from dockerhub. Using the docker-compose templates provided, you should be able to get a stack up and running easily by changing a few default values and deploying. You can deploy with either SQLite (default) or Postgres. SQLite is sufficient for most use cases. Additionally, with Mealie's automated backup and restore functionality, you can easily move between SQLite and Postgres as you wish. + +[Get Docker](https://docs.docker.com/get-docker/) + +[Mealie on Dockerhub](https://hub.docker.com/r/hkotel/mealie) + +- linux/amd64 +- linux/arm64 + + +## Step 1: Deciding on Deployment Type +SQLite is a popular, open source, self-contained, zero-configuration database that is the ideal choice for Mealie when you have 1-20 Users. If you need to support many concurrent users, you may want to consider a more robust database such as PostgreSQL. + +You can find the relevant ready to use docker-compose files for supported installations at the links below. + +- [SQLite](/mealie/documentation/getting-started/installation/sqlite/) +- [PostgreSQL](/mealie/documentation/getting-started/installation/postgres/) + +## Step 2: Customizing The `docker-compose.yaml` files. +After you've decided on a database it's important to set a few ENV variables to ensure that you can use all the features of Mealie. I recommend that you verify and check that: + +- [x] You've configured the relevant ENV variables for your database selection in the `docker-compose.yaml` files. +- [x] You've configured the [SMTP server settings](/mealie/documentation/getting-started/installation/backend-config/#email) (used for invitations, password resets, etc) +- [x] Verified the port mapped on the `mealie-frontend` container is an open port on your server (Default: 9925) +- [x] You've set the [`BASE_URL`](/mealie/documentation/getting-started/installation/backend-config/#general) variable. +- [x] You've set the `DEFAULT_EMAIL` and `DEFAULT_GROUP` variable. +- [x] Make any theme changes on the frontend container. [See Frontend Config](/mealie/documentation/getting-started/installation/frontend-config/#themeing) + +## Step 3: Startup +After you've configured your database, and updated the `docker-compose.yaml` files, you can start Mealie by running the following command in the directory where you've added your `docker-compose.yaml`. + +```bash +$ docker-compose up -d +``` + +You should see the containers start up without error. You should now be able to access the Mealie frontend at [http://localhost:9925](http://locahost:9925). + +!!! tip "Default Credentials" + + **Username:** changeme@email.com + + **Password:** MyPassword + +## Step 4: Backup +While v1.0.0 is a great step to data-stability and security, it's not a backup. As a core feature, Mealie will run a backup of the entire database every 24 hours. Optionally, you can also run backups whenever you'd like through the UI or the API. + +These backups are just plain .zip files that you can download from the UI or access via the mounted volume on your system. For complete data protection you MUST store these backups somewhere safe, and outside of the server where they are deployed. A favorite solution of mine is [autorestic](https://autorestic.vercel.app/) which can be configured via yaml to run an off-site backup on a regular basis. \ No newline at end of file diff --git a/docs/docs/documentation/getting-started/installation/postgres.md b/docs/docs/documentation/getting-started/installation/postgres.md new file mode 100644 index 00000000..24b0b604 --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/postgres.md @@ -0,0 +1,54 @@ +# Installing with PostgreSQL + +Postgres support was introduced in v0.5.0. At this point it should be used with caution and frequent backups. + +**For Environmental Variable Configuration See:** + +- [Frontend Configuration](/mealie/documentation/getting-started/installation/frontend-config/) +- [Backend Configuration](/mealie/documentation/getting-started/installation/backend-config/) + +```yaml +--- +version: "3.7" +services: + mealie-frontend: + image: hkotel/mealie:frontend-nightly + container_name: mealie-frontend + environment: + # Set Frontend ENV Variables Here + - ALLOW_SIGNUP=true + - API_URL=http://mealie-api:9000 + restart: always + ports: + - "9925:3000" + mealie-api: + image: hkotel/mealie:api-nightly + container_name: mealie-api + volumes: + - ./data/:/app/data + environment: + # Set Backend ENV Variables Here + - PUID=1000 + - PGID=1000 + - TZ=America/Anchorage + - MAX_WORKERS=1 + - WEB_CONCURRENCY=1 + - BASE_URL=https://beta.mealie.io + + # Database Settings + - DB_ENGINE=postgres + - POSTGRES_USER=mealie + - POSTGRES_PASSWORD=mealie + - POSTGRES_SERVER=postgres + - POSTGRES_PORT=5432 + - POSTGRES_DB=mealie + restart: always + postgres: + container_name: postgres + image: postgres + restart: always + environment: + POSTGRES_PASSWORD: mealie + POSTGRES_USER: mealie +``` + diff --git a/docs/docs/documentation/getting-started/installation/sqlite.md b/docs/docs/documentation/getting-started/installation/sqlite.md new file mode 100644 index 00000000..efe59f7d --- /dev/null +++ b/docs/docs/documentation/getting-started/installation/sqlite.md @@ -0,0 +1,38 @@ +# Installing with SQLite + +SQLite is a popular, open source, self-contained, zero-configuration database that is the ideal choice for Mealie when you have 1-20 Users. Below is a ready to use docker-compose.yaml file for deploying Mealie on your server. + +**For Environmental Variable Configuration See:** + +- [Frontend Configuration](/mealie/documentation/getting-started/installation/frontend-config/) +- [Backend Configuration](/mealie/documentation/getting-started/installation/backend-config/) + +```yaml +--- +version: "3.7" +services: + mealie-frontend: + image: hkotel/mealie:frontend-nightly + container_name: mealie-frontend + environment: + # Set Frontend ENV Variables Here + - ALLOW_SIGNUP=true + - API_URL=http://mealie-api:9000 + restart: always + ports: + - "9925:3000" + mealie-api: + image: hkotel/mealie:api-nightly + container_name: mealie-api + volumes: + - ./data/:/app/data + environment: + # Set Backend ENV Variables Here + - PUID=1000 + - PGID=1000 + - TZ=America/Anchorage + - MAX_WORKERS=1 + - WEB_CONCURRENCY=1 + - BASE_URL=https://beta.mealie.io + restart: always +``` \ No newline at end of file diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html index 643a32de..861af07e 100644 --- a/docs/docs/overrides/api.html +++ b/docs/docs/overrides/api.html @@ -14,7 +14,7 @@
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 026d0312..ffb236d6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -54,10 +54,15 @@ nav: - Home: "index.md" - Getting Started: - Introduction: "documentation/getting-started/introduction.md" - - Installation: "documentation/getting-started/install.md" - Updating: "documentation/getting-started/updating.md" - API: "documentation/getting-started/api-usage.md" - + - Installation: + - Installation Checklist: "documentation/getting-started/installation/installation-checklist.md" + - SQLite (Recommended): "documentation/getting-started/installation/sqlite.md" + - PostgreSQL: "documentation/getting-started/installation/postgres.md" + - Frontend Configuration: "documentation/getting-started/installation/frontend-config.md" + - Backend Configuration: "documentation/getting-started/installation/backend-config.md" + - Advanced: "documentation/getting-started/installation/advanced.md" - Recipes: - Working With Recipes: "documentation/recipes/recipes.md" - Organizing Recipes: "documentation/recipes/organizing-recipes.md" diff --git a/frontend/pages/recipes/categories/_slug.vue b/frontend/pages/recipes/categories/_slug.vue index 58851891..2688c23b 100644 --- a/frontend/pages/recipes/categories/_slug.vue +++ b/frontend/pages/recipes/categories/_slug.vue @@ -37,6 +37,7 @@ export default defineComponent({ methods: { assignSorted(val: Array) { if (this.category) { + // @ts-ignore this.category.recipes = val; } }, diff --git a/frontend/pages/recipes/tags/_slug.vue b/frontend/pages/recipes/tags/_slug.vue index 422f4f5b..177453be 100644 --- a/frontend/pages/recipes/tags/_slug.vue +++ b/frontend/pages/recipes/tags/_slug.vue @@ -37,6 +37,7 @@ export default defineComponent({ methods: { assignSorted(val: Array) { if (this.tag) { + // @ts-ignore this.tag.recipes = val; } },