Extended Paperless-ngx docs #40012
Draft
Extended Paperless-ngx docs #40012
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…a updates, known limitations
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
19 tasks
c0ffeeca7
requested changes
Jul 30, 2025
| {% endraw %} | ||
| {% enddetails %} | ||
|
|
||
| ## Data Updates |
There was a problem hiding this comment.
Suggested change
| ## Data Updates | |
| ## Data updates |
|
|
||
| ## Troubleshooting | ||
|
|
||
| {% details "Invalid hostname or IP address" %} |
There was a problem hiding this comment.
Is this a message I see? or the cause of an issue?
|
|
||
| {% enddetails %} | ||
|
|
||
| {% details "The token does not have permission to access the API" %} |
There was a problem hiding this comment.
same here. Is this an error messsage that comes up or the cause of an issue?
Comment on lines
+154
to
+161
| In this case, verify whether the token is still valid and correctly assigned to the user. | ||
|
|
||
| You can also test the token using the Swagger interface available at | ||
| `https://paperless.example.com/api/schema/view/` | ||
|
|
||
| Click on **"Authorize"** in the Swagger UI to enter your token at **tokenAuth (apiKey)**, then try accessing the relevant endpoints like `/api/statistics/` to ensure they respond as expected. | ||
|
|
||
| If everything works correctly in Swagger but the integration still fails, check whether a reverse proxy (e.g., NGINX) is returning an **HTTP 403 error**. If so, the integration may also report this as a permission issue. |
There was a problem hiding this comment.
Suggested change
| In this case, verify whether the token is still valid and correctly assigned to the user. | |
| You can also test the token using the Swagger interface available at | |
| `https://paperless.example.com/api/schema/view/` | |
| Click on **"Authorize"** in the Swagger UI to enter your token at **tokenAuth (apiKey)**, then try accessing the relevant endpoints like `/api/statistics/` to ensure they respond as expected. | |
| If everything works correctly in Swagger but the integration still fails, check whether a reverse proxy (e.g., NGINX) is returning an **HTTP 403 error**. If so, the integration may also report this as a permission issue. | |
| 1. Verify whether the token is still valid and correctly assigned to the user. | |
| 2. You can also test the token using the Swagger interface available at | |
| `https://paperless.example.com/api/schema/view/` | |
| - In the Swagger UI, select **Authorize** to enter your token at **tokenAuth (apiKey)**. | |
| - Then, try accessing the relevant endpoints like `/api/statistics/` to ensure they respond as expected. | |
| 3. If everything works correctly in Swagger but the integration still fails, check whether a reverse proxy (for example, NGINX) is returning an **HTTP 403 error**. | |
| - If so, the integration may also report this as a permission issue. |
I think this could be a step-by-step procedure
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Added some documentation for Paperless-ngx
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.