Docker/mealie
Docker/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-08-03 04:25:24 +02:00
Code Issues Releases Activity

Release v0.1.0 Candidate (#85)

Browse source 
* Changed uvicorn port to 80

* Changed port in docker-compose to match dockerfile

* Readded environment variables in docker-compose

* production image rework

* Use opengraph metadata to make basic recipe cards when full recipe metadata is not available

* fixed instrucitons on parse

* add last_recipe

* automated testing

* roadmap update

* Sqlite (#75)

* file structure

* auto-test

* take 2

* refactor ap scheduler and startup process

* fixed scraper error

* database abstraction

* database abstraction

* port recipes over to new schema

* meal migration

* start settings migration

* finale mongo port

* backup improvements

* migration imports to new DB structure

* unused import cleanup

* docs strings

* settings and theme import logic

* cleanup

* fixed tinydb error

* requirements

* fuzzy search

* remove scratch file

* sqlalchemy models

* improved search ui

* recipe models almost done

* sql modal population

* del scratch

* rewrite database model mixins

* mostly grabage

* recipe updates

* working sqllite

* remove old files and reorganize

* final cleanup

Co-authored-by: Hayden <hay-kot@pm.me>

* Backup card (#78)

* backup / import dialog

* upgrade to new tag method

* New import card

* rename settings.py to app_config.py

* migrate to poetry for development

* fix failing test

Co-authored-by: Hayden <hay-kot@pm.me>

* added mkdocs to docker-compose

* Translations (#72)

* Translations + danish

* changed back proxy target to use ENV

* Resolved more merge conflicts

* Removed test in translation

* Documentation of translations

* Updated translations

* removed old packages

Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>

* fail to start bug fixes

* feature: prep/cook/total time slots (#80)

Co-authored-by: Hayden <hay-kot@pm.me>

* missing bind attributes

* Bug fixes (#81)

* fix: url remains after succesful import

* docs: changelog + update todos

* arm image

* arm compose

* compose updates

* update poetry

* arm support

Co-authored-by: Hayden <hay-kot@pm.me>

* dockerfile hotfix

* dockerfile hotfix

* Version Release Final Touches (#84)

* Remove slim

* bug: opacity issues

* bug: startup failure with no database

* ci/cd on dev branch

* formatting

* v0.1.0 documentation

Co-authored-by: Hayden <hay-kot@pm.me>

* db init hotfix

* bug: fix crash in mongo

* fix mongo bug

* fixed version notifier

* finale changelog

Co-authored-by: kentora <=>
Co-authored-by: Hayden <hay-kot@pm.me>
Co-authored-by: Richard Mitic <richard.h.mitic@gmail.com>
Co-authored-by: kentora <kentora@kentora.dk>
This commit is contained in:
Hayden 2021-01-17 22:22:54 -09:00 • committed by GitHub
parent f6c1fa0e8b
commit 88dfd40b8d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
173 changed files with 10273 additions and 3735 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/docs/changelog.md
View file

@ -1,7 +1,39 @@
# Release Notes
## v0.1.0 - Initial Beta
### Bug Fixes
- Fixed Can't delete recipe after changing name - Closes Issue #67
- Fixed No image when added by URL, and can;t add an image - Closes Issue #66
- Fixed Images saved with no way to delete when add recipe via URL fails - Closes Issue #43
### Features
- Additional Language Support
- Improved deployment documentation
- Additional database! SQlite is now supported! - Closes #48
- All site data is now backed up.
- Support for Prep Time, Total Time, and Cook Time field - Closes #63
- New backup import process with support for themes and site settings
- **BETA** ARM support! - Closes #69
### Code / Developer Improvements
- Unified Database Access Layers
- Poetry / pyproject.toml support over requirements.txt
- Local development without database is now possible!
- Local mkdocs server added to docker-compose.dev.yml
- Major code refactoring to support new database layer
- Global variable refactor
### Break Changes
- Internal docker port is now 80 instead of 9000. You MUST remap the internal port to connect to the UI.
!!! error "Breaking Changes"
As I've adopted the SQL database model I find that using 2 different types of databases will inevitably hinder development. As such after release v0.1.0 support for mongoDB will no longer be available. Prior to upgrading to v0.2.0 you will need to export your site and import after updating. This should be a painless process and require minimal intervention on the users part. Moving forward we will do our best to minimize changes that require user intervention like this and make updates a smooth process.
## v0.0.2 - Pre-release Second Patch
A quality update with major props to [zackbcom](https://github.com/zackbcom) for working hard on making the theming just that much better!
### Bug Fixes
- Fixed empty backup failure without markdown template
- Fixed opacity issues with marked steps - [mtoohey31](https://github.com/mtoohey31)

1
docs/docs/contributors/non-coders.md
View file

@ -7,6 +7,7 @@ We love your input! We want to make contributing to this project as easy and tra
- Submitting a fix
- Proposing new features
- Becoming a maintainer
- [Help translate to a new language or improve current translations](../translating)
[Remember to join the Discord and stay in touch with other developers working on the project](https://discord.gg/R6QDyJgbD2)!

15
docs/docs/contributors/translating.md Normal file
View file

@ -0,0 +1,15 @@
# Contributing with translations
Having Mealie in different language could help the adaption of Mealie. Translations can be a great way for non-coders to contribute to Mealie.
## Is Mealie missing in your language?
If your language is missing, you can add it, by beginning to translate. We use a Vue-i18n in json files. Copy frontend/src/locales/en.json to get started.
## Improving translations
If your language is missing the translation for some strings, you can help out by adding a translation for that string. If you find a string you think could be improved, please feel free to do so.
## Tooling
Currently we use Vue-i18n for translations. Translations are stored in json format located in [frontend/src/locales](https://github.com/hay-kot/mealie/tree/master/frontend/src/locales).
If you have experience with a good Translation Management System, please feel free to chime in on the [Discord](https://discord.gg/R6QDyJgbD2), as such a system could be helpful as the projects grow.
Until then, [i18n Ally for VScode](https://marketplace.visualstudio.com/items?itemName=antfu.i18n-ally) is recommended to aid in translating. It also has a nice feature, which shows translations in-place when editing code.
i18n Ally will also show which languages is missing translations.

2
docs/docs/getting-started/backups-and-exports.md
View file

@ -3,7 +3,7 @@
All recipe data can be imported and exported as necessary from the UI. Under the admin page you'll find the section for using Backups and Exports.
To create an export simple add the tag and the markdown template and click Backup Recipes and your backup will be created on the server. The backup is a standard zipfile containing all the images, json files, and rendered markdown files for each recipe. Markdown files are rendered from jinja2 templates. Adding your own markdown file into the templates folder will automatically show up as an option to select when creating a backup. To view the availible variables, open a recipe in the json editor.
To create an export simple add the tag and the markdown template and click Backup Recipes and your backup will be created on the server. The backup is a standard zipfile containing all the images, json files, and rendered markdown files for each recipe. Markdown files are rendered from jinja2 templates. Adding your own markdown file into the templates folder will automatically show up as an option to select when creating a backup. To view the available variables, open a recipe in the json editor.
To import a backup it must be in your backups folder. If it is in the backup folder it will automatically show up as an source to restore from. Selected the desired backup and import the backup file.

106
docs/docs/getting-started/install.md
View file

@ -1,26 +1,46 @@
# Installation
To deploy docker 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. Currently the only supported database is Mongo. Mealie is looking for contributors to support additional databases.
To deploy docker 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. Currently MongoDB and SQLite are supported. MongoDB support will be dropped in v0.2.0 so it is recommended to go with SQLite for new deployments. Postrgres support is planned for the next release, however for most loads you may find SQLite performant enough.
[Get Docker](https://docs.docker.com/get-docker/)
[Mealie Docker Image](https://hub.docker.com/r/hkotel/mealie)
## Env Variables
| Variables | default | description |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mealie_db_name | mealie | The name of the database to be created in Mongodb |
| mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. |
| db_username | root | The Mongodb username you specified in your mongo container |
| db_password | example | The Mongodb password you specified in your mongo container |
| db_host | mongo | The host address of MongoDB if you're in docker and using the same network you can use mongo as the host name |
| db_port | 27017 | the port to access MongoDB 27017 is the default for mongo |
| api_docs | True | Turns on/off access to the API documentation locally. |
| TZ | | You should set your time zone accordingly so the date/time features work correctly |
## 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 `9000`, mounting the current directory, and pull the latest image. After the image is up an running you can navigate to http://your.ip.addres:9000 and you'll should see mealie up and running!
```shell
docker run \
-e db_type='sqlite' \
-p 9000:80 \
-v `pwd`:'/app/data/' \
hkotel/mealie:latest
```
## 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 `9000` 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:
- 9000:80
environment:
db_type: sqlite
TZ: America/Anchorage
volumes:
- ./mealie/data/:/app/data
```
## Docker Compose
## Docker Compose with Mongo - DEPRECIATED
```yaml
# docker-compose.yml
@ -31,7 +51,7 @@ services:
image: hkotel/mealie:latest
restart: always
ports:
- 9000:9000
- 9000:80
environment:
db_username: root # Your Mongo DB Username - Please Change
db_password: example # Your Mongo DB Password - Please Change
@ -61,55 +81,21 @@ services:
```
## Ansible Tasks Template
```yaml
- name: ensures Mealie directory dir exists
file:
path: "{{ docker_dir }}/mealie/"
state: directory
owner: "{{ main_user}}"
group: "{{ main_group }}"
## Env Variables
- name: ensures Mealie directory dir exists
file:
path: "{{ docker_dir }}/mealie/"
state: directory
owner: "{{ main_user}}"
group: "{{ main_group }}"
| Variables | default | description |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| db_type | sqlite | The database type to be used. Current Options 'sqlite' and 'mongo' |
| mealie_db_name | mealie | The name of the database to be created in Mongodb |
| mealie_port | 9000 | The port exposed by mealie. **do not change this if you're running in docker** If you'd like to use another port, map 9000 to another port of the host. |
| db_username | root | The Mongodb username you specified in your mongo container |
| db_password | example | The Mongodb password you specified in your mongo container |
| db_host | mongo | The host address of MongoDB if you're in docker and using the same network you can use mongo as the host name |
| db_port | 27017 | the port to access MongoDB 27017 is the default for mongo |
| api_docs | True | Turns on/off access to the API documentation locally. |
| TZ | | You should set your time zone accordingly so the date/time features work correctly |
- name: Deploy Monogo Database
docker_container:
name: mealie-mongo
image: mongo
restart_policy: unless-stopped
networks:
- name: web
env:
MONGO_INITDB_ROOT_USERNAME: root
MONGO_INITDB_ROOT_PASSWORD: example
- name: deploy Mealie Docker Container
docker_container:
name: mealie
image: hkotel/mealie:latest
restart_policy: unless-stopped
ports:
- 9090:9000
networks:
- name: web
mounts:
- type: bind
source: "{{ docker_dir }}/mealie"
target: /app/data
env:
db_username: root
db_password: example
db_host: mealie-mongo
db_port: "27017"
```
## Deployed as a Python Application
Alternatively, this project is built on Python and Mongodb. If you are dead set on deploying on a linux machine you can run this in an python environment with a dedicated MongoDatabase. Provided that you know thats how you want to host the application, I'll assume you know how to do that. I may or may not get around to writing this guide. I'm open to pull requests if anyone has a good guide on it.

18
docs/docs/getting-started/migration-imports.md
View file

@ -6,7 +6,21 @@ In the Admin page on the in the Migration section you can provide a URL for a re
We'd like to support additional migration paths. [See open issues.](https://github.com/hay-kot/mealie/issues)
**Currently Proposed Are:**
### Nextcloud Recipes
Nextcloud recipes can be imported from either a zip file the contains the data stored in Nextcloud. The zip file can be uploaded from the frontend or placed in the data/migrations/Nextcloud directory. See the example folder structure below to ensure your recipes are able to be imported.
- NextCloud Recipes
```
nextcloud_recipes.zip
├── recipe_1
│ ├── recipe.json
│ ├── full.jpg
│ └── thumb.jpg
├── recipe_2
│ ├── recipe.json
│ └── full.jpg
└── recipe_3
└── recipe.json
```
**Currently Proposed Are:**
- Open Eats

2
docs/docs/html/api.html
View file

File diff suppressed because one or more lines are too long

138
docs/docs/img/app_diagram.drawio.svg Normal file
View file

File diff suppressed because one or more lines are too long
Side by side

After

Width:  |  Height:  |  Size: 67 KiB

49
docs/docs/roadmap.md
View file

@ -1,12 +1,12 @@
# Development Road Map
!!! Current Release
v0.0.0 ALPHA - This is technically a pre-release, as such there are no release notes and no version. The first version will be version v0.1.0 and will provide a list of release notes with any breaking changes
v0.1.0 BETA - This is technically a pre-release, as such take care to backup data and be aware that breaking changes in future releases are a real possibility.
Feature placement is not set in stone. This is much more of a guideline than anything else.
## v1.0 Road Map
## v x.x.x - No planned target, but eventually...
### Frontend
- [ ] Login / Logout Navigation
@ -14,6 +14,7 @@ Feature placement is not set in stone. This is much more of a guideline than any
* [ ] Logic / Function Calls
* [ ] Password Reset
### Backend
- [ ] Image Minification
- [ ] User Setup
* [ ] Authentication
* [ ] Default Admin/Superuser Account
@ -21,25 +22,31 @@ Feature placement is not set in stone. This is much more of a guideline than any
* [ ] User Accounts
* [ ] Edit / Delete
## v0.1.0
### Front End
- [ ] Recipe Editor
* [ ] Basic Form Validation
- [ ] Recipe Viewer
* [ ] Print Page View - Like King Arthur Website
* [ ] Total Time Indicator
* [ ] Bake Time
## v0.2.0 - Targets
!!! error "MAJOR BREAKING CHANGE"
MongoDB will no longer be supported as of v0.2.0. Review the database migration page for details on migration to SQL (It's very easy)
## New Features
### Frontend
- [ ] Advanced search
- [ ] Category Filter
- [ ] Tag Filter
- [x] Fuzzy Search
- [ ] Backup card redesign
- [ ] Additional Backup / Import Features
- [ ] Import Recipes Force/Rebase options
- [ ] Upload .zip file
- [ ] Improved Color Picker
- [ ] Meal Plan redesign
### Backend
- [ ] Recipe Data
* [ ] Better Scraper
* [ ] Image Minification
* [ ] Scraper Data Validation
- [ ] Category Management
* [ ] Lunch / Dinner / Breakfast <- Meal Generation
* [ ] Dessert / Side / Appetizer / Bread / Drinks /
- [ ] Backup Options
* [ ] Force Update
* [ ] Rebuild
- [ ] PostgreSQL Support
- [ ] Setup SQL Migrations
## Breaking Changes
- Internal port 9000 changed to port 80 for better Traefik support
- MongoDB support dropped
## Code Chores
- [ ] Remove MongoDB Interface Code
- [ ] Dockerfile Trim

1
docs/mkdocs.yml
View file

@ -38,6 +38,7 @@ nav:
- API Documentation: "api/docs/index.html"
- Contributors Guide:
- Non-Code: "contributors/non-coders.md"
- Translating: "contributors/translating"
- Developers Guide:
- Code Contributions: "contributors/developers-guide/code-contributions.md"
- Dev Getting Started: "contributors/developers-guide/starting-dev-server.md"