Skip to content

docs(paperless): list the Paperless permissions the token needs - #23

Open
marcfischer wants to merge 1 commit into
bulwarkmail:mainfrom
marcfischer:docs/paperless-token-permissions
Open

marcfischer wants to merge 1 commit into
bulwarkmail:mainfrom
marcfischer:docs/paperless-token-permissions

Conversation

@marcfischer

Copy link
Copy Markdown
Contributor

Summary

The README explains how to connect a Paperless API token but not which Paperless permissions the user behind it needs. Admins setting up a restricted (non-superuser) account had to guess. This adds a table of the required Paperless permissions, derived from the API calls the plugin makes.

Changes

  • New section Paperless permissions under Setting it up:
    • UI Settings: View (connection check via /api/ui_settings/)
    • Documents: View, Add
    • Tags, Correspondents, Document Types: View
    • Storage Paths: View (optional)
    • Tasks: View (import status after upload)
  • Note that object-level permissions limit what the user sees, and that a shared token should not belong to a superuser

Related issues

None.

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactor / code quality improvement
  • Chore / dependency update / CI change

Checklist

  • I have read the Contributing Guide
  • My code follows the project's code style and conventions
  • I have run npm run typecheck && npm run lint and there are no errors
  • The build passes (npm run build)
  • I have tested my changes locally
  • I have added or updated documentation if needed
  • I have updated translations (locales/) if my changes affect user-facing text
  • I have included screenshots or a screen recording for UI changes

Notes for reviewers

  • README only, no code change.
  • The list comes from reading src/lib/client.js and src/lib/connection.js (only GET calls plus post_document); I haven't verified it against a live Paperless instance with a restricted user. If you know of a call that needs more, happy to adjust.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant