]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Documentation: add workflow permissions note (#10038)
authorshamoon <4887959+shamoon@users.noreply.github.com>
Sun, 25 May 2025 16:18:48 +0000 (09:18 -0700)
committerGitHub <noreply@github.com>
Sun, 25 May 2025 16:18:48 +0000 (09:18 -0700)
docs/usage.md

index 1b691e678b1d49e7a2892428042bc38116ce3da2..7065576027f22d502998d4dccf979acbd1e4029b 100644 (file)
@@ -338,25 +338,25 @@ Global permissions define what areas of the app and API endpoints users can acce
 determine if a user can create, edit, delete or view _any_ documents, but individual documents themselves
 still have "object-level" permissions.
 
-| Type          | Details                                                                                                                                                                  |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| AppConfig     | _Change_ or higher permissions grants access to the "Application Configuration" area.                                                                                    |
-| Correspondent | Add, edit, delete or view Correspondents.                                                                                                                                |
-| CustomField   | Add, edit, delete or view Custom Fields.                                                                                                                                 |
-| Document      | Add, edit, delete or view Documents.                                                                                                                                     |
-| DocumentType  | Add, edit, delete or view Document Types.                                                                                                                                |
-| Group         | Add, edit, delete or view Groups.                                                                                                                                        |
-| MailAccount   | Add, edit, delete or view Mail Accounts.                                                                                                                                 |
-| MailRule      | Add, edit, delete or view Mail Rules.                                                                                                                                    |
-| Note          | Add, edit, delete or view Notes.                                                                                                                                         |
-| PaperlessTask | View or dismiss (_Change_) File Tasks.                                                                                                                                   |
-| SavedView     | Add, edit, delete or view Saved Views.                                                                                                                                   |
-| ShareLink     | Add, delete or view Share Links.                                                                                                                                         |
-| StoragePath   | Add, edit, delete or view Storage Paths.                                                                                                                                 |
-| Tag           | Add, edit, delete or view Tags.                                                                                                                                          |
-| UISettings    | Add, edit, delete or view the UI settings that are used by the web app.<br/>:warning: **Users that will access the web UI must be granted at least _View_ permissions.** |
-| User          | Add, edit, delete or view Users.                                                                                                                                         |
-| Workflow      | Add, edit, delete or view Workflows.<br/>Note that Workflows are global, in other words all users who can access workflows have access to the same set of them.          |
+| Type          | Details                                                                                                                                                                                                                         |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| AppConfig     | _Change_ or higher permissions grants access to the "Application Configuration" area.                                                                                                                                           |
+| Correspondent | Add, edit, delete or view Correspondents.                                                                                                                                                                                       |
+| CustomField   | Add, edit, delete or view Custom Fields.                                                                                                                                                                                        |
+| Document      | Add, edit, delete or view Documents.                                                                                                                                                                                            |
+| DocumentType  | Add, edit, delete or view Document Types.                                                                                                                                                                                       |
+| Group         | Add, edit, delete or view Groups.                                                                                                                                                                                               |
+| MailAccount   | Add, edit, delete or view Mail Accounts.                                                                                                                                                                                        |
+| MailRule      | Add, edit, delete or view Mail Rules.                                                                                                                                                                                           |
+| Note          | Add, edit, delete or view Notes.                                                                                                                                                                                                |
+| PaperlessTask | View or dismiss (_Change_) File Tasks.                                                                                                                                                                                          |
+| SavedView     | Add, edit, delete or view Saved Views.                                                                                                                                                                                          |
+| ShareLink     | Add, delete or view Share Links.                                                                                                                                                                                                |
+| StoragePath   | Add, edit, delete or view Storage Paths.                                                                                                                                                                                        |
+| Tag           | Add, edit, delete or view Tags.                                                                                                                                                                                                 |
+| UISettings    | Add, edit, delete or view the UI settings that are used by the web app.<br/>:warning: **Users that will access the web UI must be granted at least _View_ permissions.**                                                        |
+| User          | Add, edit, delete or view Users.                                                                                                                                                                                                |
+| Workflow      | Add, edit, delete or view Workflows.<br/>Note that Workflows are global; all users who can access workflows see the same set. Workflows have other permission implications — see [Workflow permissions](#workflow-permissions). |
 
 #### Detailed Explanation of Object Permissions {#object-permissions}
 
@@ -533,7 +533,7 @@ The following placeholders are only available for "added" or "updated" triggers
 All users who have application permissions for editing workflows can see the same set
 of workflows. In other words, workflows themselves intentionally do not have an owner or permissions.
 
-Given their potentially far-reaching capabilities, you may want to restrict access to workflows.
+Given their potentially far-reaching capabilities, including changing the permissions of existing documents, you may want to restrict access to workflows.
 
 Upon migration, existing installs will grant access to workflows to users who can add
 documents (and superusers who can always access all parts of the app).