jonaswinkler / paperless-ng

A supercharged version of paperless: scan, index and archive all your physical documents
https://paperless-ng.readthedocs.io/en/latest/
GNU General Public License v3.0
5.38k stars 354 forks source link

RSS and OPDS read-only endpoints? #443

Closed Matthias84 closed 3 years ago

Matthias84 commented 3 years ago

Hi, first let me say, that I see that this feature makes a lot of work, even if you use existing packages. I like just to present the idea, so others might want to support it.

RSS feeds are a common way to get listings and updates for hierarchical content. By polling this XML documents, client software can browse content libraries and analyse documents metadata catalogues. It's still in use for blogosphere, news planets, podcasts, ...

OPDS 1.2 makes use of RSS and Dublin Core schemas originally to share ebook libraries with client software. There is opensource software as calibre to selfhost your personal ebook library. But the concept is flexible as well and can be used for any platforms which share documents, so to subscribe to technical / research / political portals.

I suggest to add both features with different endpoints, so users can subscribe to changes on documents

OPDS itself adds ability to perform full text search and discovery & navigate trough the catalog. For RSS there is the Django syndication framework, which allows custom model customization, following different formats. For OPDS it is possiible to use the same framework, but there are also some Django projects which implement it already SOPDS, pathagar, ... , python as calibre-web and there are also addons to calibre or nextcloud to spread documents.

IMHO paperless can benefits to implement this standards, so (external) users and scripts on different hosts to trigger on added content and to work with listings. It allows to access, read and search & navigate trough hierarchies via existing native apps esp. for non mainstream OS (coolreader, fbreader, libera, ...) and via ebook reader hardware (kindle, kobo, tolino, ...). I think they are easier to use by non tech users, which don't maintain the setup. And a DMS is usually used by many more users to search & consume documents, than by only a limited amount of users add the documents or have to curate them. This interface might also allow to cascade & federate between different paperless instances to find documents in a global manner.

jonaswinkler commented 3 years ago

I believe you're thinking bigger than I am. A Paperless instance isn't really supposed to be shared across hundreds of users, and I see limited benefit for adding these interfaces to paperless.

Of course, if someone wants to implement (and maintain) that feature, sure, why not.

jonaswinkler commented 3 years ago

Closing this as out of scope.