Skip to content

Commit f06d434

Browse files
committed
docs: Fix permissions documentation
1 parent 58241ff commit f06d434

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

docs/common_issues/permissions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Minimum permissions
2+
3+
Permissions in Paperless-ngx control what resources a logged in user has access to.
4+
Generally, Swift Paperless will respect the given permissions and not try to load resources
5+
that the user will not be able to access.
6+
7+
For the app to function correctly, it needs to be able to query information about the logged in user itself,
8+
which includes the level of permissions the user has. Without this level of access, the functionality of the app cannot be provided.
9+
10+
Please ensure that the user you're trying to log in with has at leas the *UI Settings* permissions set in the web interface under *Users & Groups*:
11+
12+
![Screenshot of the permissions interface](minimum-permissions.png)

mkdocs.yml

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,16 @@ plugins:
2727
- literate-nav
2828
- redirects:
2929
redirect_maps:
30-
"common-issues/forbidden.md": "common_issues/forbidden.md"
3130
"common-issues/invalid-certificate.md": "common_issues/certificates.md"
3231
"common_issues/invalid-certificate.md": "common_issues/certificates.md"
3332

34-
# @TODO: Enable when v1.8.0 is live
35-
# "common_issues/forbidden.md": "common_issues/permissions.md"
36-
# "common-issues/forbidden.md": "common_issues/permissions.md"
33+
"common_issues/forbidden.md": "common_issues/permissions.md"
34+
"common-issues/forbidden.md": "common_issues/permissions.md"
35+
"common_issues/insufficient-permissions.md": "common_issues/permissions.md"
3736

3837
"common-issues/local-network-denied.md": "common_issues/local-network-denied.md"
3938

4039

41-
# @TODO: Enable when v1.8.0 is live
42-
"common_issues/insufficient-permissions.md": "common_issues/forbidden.md"
43-
4440
markdown_extensions:
4541
- pymdownx.snippets:
4642
- attr_list
@@ -55,11 +51,8 @@ nav:
5551
- deeplinks.md
5652
- oidc.md
5753
- Common Issues:
58-
# @TODO: Remove when v1.8.0 is live
59-
- common_issues/forbidden.md
54+
- common_issues/permissions.md
6055

61-
# @TODO: Make separate page when https://github.com/paulgessinger/swift-paperless/pull/200 lands in App Store release
62-
# - common_issues/insufficient-permissions.md
6356
- common_issues/local-network-denied.md
6457
- common_issues/certificates.md
6558
- common_issues/supported-versions.md

0 commit comments

Comments
 (0)