mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-07-19 21:29:40 +02:00
b3f7f2d89f
* added more info regarding public recipes * fix broken info tag * added more information to the 0.5.x migration * added email banner to frontend codebase
57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
# Permissions and Public Access
|
|
|
|
Mealie provides various levels of user access and permissions. This includes:
|
|
- Authentication and registration ([check out the LDAP guide](./ldap.md) for how to configure access using LDAP)
|
|
- Customizable user permissions
|
|
- Fine-tuned public access for non-users
|
|
|
|
## Customizable User Permissions
|
|
|
|
Each user can be configured to have varying levels of access. Some of these permissions include:
|
|
- Access to Administrator tools
|
|
- Access to inviting other users
|
|
- Access to manage their group and group data
|
|
|
|
Administrators can navigate to the Settings page and access the User Management page to configure these settings.
|
|
|
|
|
|
[User Management Demo](https://demo.mealie.io/admin/manage/users){ .md-button .md-button--primary }
|
|
|
|
## Public Recipe Access
|
|
|
|
By default, groups are set to private, meaning only logged-in users may access the group. In order for a recipe to be viewable by public (not logged-in) users, two criteria must be met:
|
|
|
|
1. The group must not be private, *and* the group setting for allowing users outside of your group to see your recipes must be enabled. These can be toggled on the Group Settings page
|
|
2. The recipe must be set to public. This can be toggled for each recipe individually, or in bulk using the Recipe Data Management page
|
|
|
|
Additionally, if the group is not private, public users can view all public group data (public recipes, public cookbooks, etc.) from the home page ([e.g. the demo home page](https://demo.mealie.io/g/home)).
|
|
|
|
[Group Settings Demo](https://demo.mealie.io/group){ .md-button .md-button--primary }
|
|
|
|
More broadly, here are the rules for how recipe access is determined:
|
|
|
|
- Private links that are generated from the recipe page using the `Share` button bypass all group and recipe permissions
|
|
- Private groups block all access to recipes, including those that are public, except as noted above.
|
|
- Groups with "Allow users outside of your group to see your recipes" disabled block all access to recipes, except as noted above.
|
|
- Private recipes block all access to the recipe from public links. This does not affect Private Links.
|
|
|
|
```mermaid
|
|
stateDiagram-v2
|
|
r1: Request Access
|
|
p1: Using Private Link?
|
|
p2: Is Group Private?
|
|
p3: Is Recipe Private?
|
|
s1: Deny Access
|
|
n1: Allow Access
|
|
|
|
|
|
r1 --> p1
|
|
p1 --> p2: No
|
|
p1 --> n1: Yes
|
|
|
|
p2 --> s1: Yes
|
|
p2 --> p3: No
|
|
|
|
p3 --> s1: Yes
|
|
p3 --> n1: No
|
|
```
|