Skip to content

docs: Add community guide for integrating the Mealie-Bring-API #4920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 21, 2025
Merged

docs: Add community guide for integrating the Mealie-Bring-API #4920

merged 3 commits into from
Jan 21, 2025

Conversation

felixschndr
Copy link
Contributor

What this PR does / why we need it:

See #3627 (reply in thread)

Special notes for your reviewer:

I was not sure whether there is some crucial information missing. I din't want to add to many details as all the information is described in the repository the docs link to and I didn't want to add any unnecessary duplication. Do you think anything shall be added?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 20, 2025
@michael-genson
Copy link
Collaborator

Placement looks good, can you elaborate more on the specific use-case isn't resolved by #4676? That PR will make it so Mealie doesn't have to be publicly accessible to use the Bring integration, but it does need to be exposed to the internet (whereas, if I understand correctly, your integration allows Mealie to stay locked behind local network access only)

Otherwise I agree, no need to duplicate docs when you link to the project. Maybe a quick "check out the project for installation instructions" or something similar, just to clarify that you won't find them in the Mealie docs.

@felixschndr
Copy link
Contributor Author

felixschndr commented Jan 21, 2025

That PR will make it so Mealie doesn't have to be publicly accessible to use the Bring integration, but it does need to be exposed to the internet

Can you please explain what you mean by that? Does that mean Mealie has to be exposed to the internet and the recipe can be shared even though it normally would require a user login?

whereas, if I understand correctly, your integration allows Mealie to stay locked behind local network access only

exactly, no service has to be exposed to the internet at all. I will add a comment to make this clearer in the docs (edit: done in d369cab)

@michael-genson michael-genson enabled auto-merge (squash) January 21, 2025 16:32
Copy link
Collaborator

@michael-genson michael-genson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!

Does that mean Mealie has to be exposed to the internet and the recipe can be shared even though it normally would require a user login?

Yup, that's right. Once that PR is merged Mealie will still need to be exposed to the internet, however it won't require a login for the Bring integration (and similar usecases). Your web server adds an extra layer of protection though since it doesn't require Mealie to have external access

@michael-genson michael-genson merged commit 17bed60 into mealie-recipes:mealie-next Jan 21, 2025
13 checks passed
@felixschndr felixschndr deleted the 3627-add-mealie-bring-api-docs branch January 21, 2025 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants