What Topics Are Covered in the Paperless-ngx Documentation?

Updated

The Paperless-ngx documentation covers the full lifecycle of running the software: product overview, installation, configuration, day-to-day usage, administration, troubleshooting, development, and the REST API. The site at paperless-ngx.readthedocs.io is the 1.10.0 version of that documentation, and its own front page states that the documentation "has permanently moved" and that visitors will be redirected shortly. So the topic list below describes what this documentation set contains, but the current, maintained copy lives elsewhere.

Overview and orientation topics

These sections answer "what is this and what does it look like" before you commit to installing anything:

  • Screenshots — visual examples of the interface, useful for judging whether the workflow matches how you handle documents.
  • Overview — the high-level explanation of what Paperless-ngx does and how its pieces fit together.
  • Frequently asked questions — short answers to recurring questions, a good first stop before digging into setup.

Setup, configuration, and administration

This is the operational core of the documentation, aimed at whoever installs and maintains the instance:

  • Setup — getting an instance running.
  • Configuration — adjusting the instance's behavior through its settings.
  • Administration — ongoing management of users, documents, and the running system.
  • Scanners & Software — guidance on the scanning hardware and companion software that feed documents into Paperless-ngx.

Usage, advanced topics, and troubleshooting

These sections are for people who already have a working instance:

  • Usage — the everyday operations: how documents enter the system and how you work with them afterward.
  • Advanced topics — deeper configuration and less common workflows that go beyond the basics.
  • Troubleshooting — what to check when something behaves unexpectedly.

Developer-facing topics

If you intend to extend or integrate with Paperless-ngx rather than just run it:

  • Development — working on the codebase itself.
  • The REST API — programmatic access, which is the relevant section if you plan to connect external tools or scripts.
  • Changelog — the record of what changed between releases, useful for deciding whether an upgrade affects you.

How to use this list

Your goal Sections to read first
Decide whether to adopt it Screenshots, Overview, FAQ
Install and run it Setup, Configuration, Administration
Use it day to day Usage, Scanners & Software
Fix a problem Troubleshooting, FAQ
Build an integration REST API, Development
Track changes Changelog

One practical caveat: because the 1.10.0 site announces a permanent move, treat it as a version-specific snapshot rather than the place to look for current instructions. If you are installing today, follow the redirect to the relocated documentation so your Setup and Configuration steps match the release you are actually running.