Skip to content
Pocket Homelab
Get the appComing soon to the App Store

Pocket Documents

Pocket Documents as the app behind the Documents tab, scans and uploads instead of Paperless-ngx, chosen under Settings → Services → Documents.

iPhoneMacAndroid
On this page

Pocket Documents is a self-hosted document archive with OCR, full-text search and filing that learns, made as a lighter Paperless-ngx. It serves the Paperless-ngx API, so everything Pocket Homelab does with Paperless-ngx works with it: the inbox, search, tags, correspondents, types and storage paths, notes, edits and bulk edits, previews and downloads, suggestions, uploads and camera scans, and share links.

You can also receive this connection through Pocket Core, or keep configuring it individually.

Choose the app

Settings → Services → Documents starts with Documents app: Pocket Documents or Paperless-ngx. The fields under it follow the choice, and the other app’s settings are kept, so you can switch back at any time.

  1. In Pocket Documents, open Settings → API tokens and create a token. It starts with pd_ and is shown once.
  2. In Pocket Homelab: Settings → Services → Documents, choose Pocket Documents, paste its address and the token, then Test connection. It answers with your account and the number of documents.
Environment keys
KeyFieldRequiredSecretWhere to get it
DOCUMENTS_BACKENDDocuments appOptional—pocket or paperless. Empty means Pocket Documents when it has an address, else Paperless-ngx.
DOCUMENTS_URLPocket Documents URLRequired—Base address of your Pocket Documents server.
DOCUMENTS_API_KEYPocket Documents API tokenRequiredSecretSettings → API tokens in Pocket Documents (pd_…). Stored in the Keychain.

What to know

  • Share links are Pocket Documents’ own: a public page at /s/…, for a number of whole days (an end date is rounded up to days).
  • Open in Pocket Documents opens the document’s page in its web app.
  • Documents kept on the device for offline reading belong to the server they came from.