paperless-ng 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
paperless-ng 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
paperless-ng 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !

软件简介

ci Ansible Role Crowdin Documentation Status Gitter Docker Hub Pulls Coverage Status

Paperless-ng

Paperless (click me) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents.

Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood. These key points should help you decide whether Paperless-ng is something you would prefer over Paperless:

  • Interface: The new front end is the main interface for Paperless-ng, the old interface still exists but most customizations (such as thumbnails for the document list) have been removed.0
  • Encryption: Paperless-ng does not support GnuPG anymore, since storing your data on encrypted file systems (that you optionally mount on demand) achieves about the same result.
  • Resource usage: Paperless-ng does use a bit more resources than Paperless. Running the web server requires about 300MB of RAM or more, depending on the configuration. While adding documents, it requires about 300MB additional RAM, depending on the document. It still runs on Raspberry Pi (many users do that), but it has been generally geared to better use the resources of more powerful systems.
  • API changes: If you rely on the REST API of paperless, some of its functionality has been changed.

For a detailed list of changes, have a look at the change log in the documentation, especially the section about the 0.9.0 release.

How it Works

Paperless does not control your scanner, it only helps you deal with what your scanner produces.

  1. Buy a document scanner that can write to a place on your network. If you need some inspiration, have a look at the scanner recommendations page. Set it up to "scan to FTP" or something similar. It should be able to push scanned images to a server without you having to do anything. Of course if your scanner doesn't know how to automatically upload the file somewhere, you can always do that manually. Paperless doesn't care how the documents get into its local consumption directory.

    • Alternatively, you can use any of the mobile scanning apps out there. We have an app that allows you to share documents with paperless, if you're on Android. See the section on affiliated projects below.
  2. Wait for paperless to process your files. OCR is expensive, and depending on the power of your machine, this might take a bit of time.

  3. Use the web frontend to sift through the database and find what you want.

  4. Download the PDF you need/want via the web interface and do whatever you like with it. You can even print it and send it as if it's the original. In most cases, no one will care or notice.

Here's what you get:

Dashboard

If you want to see paperless-ng in action, more screenshots are available in the documentation.

Features

  • Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
  • Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
    • Office document support is optional and provided by Apache Tika (see configuration)
  • Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
  • Single page application front end.
    • Includes a dashboard that shows basic statistics and has document upload.
    • Filtering by tags, correspondents, types, and more.
    • Customizable views can be saved and displayed on the dashboard.
  • Full text search helps you find what you need.
    • Auto completion suggests relevant words from your documents.
    • Results are sorted by relevance to your search query.
    • Highlighting shows you which parts of the document matched the query.
    • Searching for similar documents ("More like this")
  • Email processing: Paperless adds documents from your email accounts.
    • Configure multiple accounts and filters for each account.
    • When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
  • Machine learning powered document matching.
    • Paperless learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
  • Optimized for multi core systems: Paperless-ng consumes multiple documents in parallel.
  • The integrated sanity checker makes sure that your document archive is in good health.

Getting started

The recommended way to deploy paperless is docker-compose. The files in the /docker/compose directory are configured to pull the image from Docker Hub.

Read the documentation on how to get started.

Alternatively, you can install the dependencies and setup apache and a database server yourself. The documenation has a step by step guide on how to do it. Consider giving the Ansible role a shot, this essentially automates the entire bare metal installation process.

Migrating from Paperless to Paperless-ng

Read the section about migration in the documentation. Its also entirely possible to go back to Paperless by reverting the database migrations.

Documentation

The documentation for Paperless-ng is available on ReadTheDocs.

Translation

Paperless is available in many different languages. Translation is coordinated at crowdin. If you want to help out by translating paperless into your language, please head over to https://github.com/jonaswinkler/paperless-ng/issues/212 for details!

Feature Requests

Feature requests can be submitted via GitHub Discussions, you can search for existing ideas, add your own and vote for the ones you care about! Note that some older feature requests can also be found under issues.

Questions? Something not working?

For bugs please open an issue or start a discussion if you have questions.

Feel like helping out?

There's still lots of things to be done, just have a look at open issues & discussions. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. The documentation has some basic information on how to get started.

If you want to implement something big: Please start a discussion about that! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested.

Affiliated Projects

Paperless has been around a while now, and people are starting to build stuff on top of it. If you're one of those people, we can add your project to this list:

  • Paperless App: An Android/iOS app for Paperless. Updated to work with paperless-ng.
  • Paperless Share. Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents.
  • Scan to Paperless: Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless.

These projects also exist, but their status and compatibility with paperless-ng is unknown.

  • paperless-cli: A golang command line binary to interact with a Paperless instance.

This project also exists, but needs updates to be compatile with paperless-ng.

  • Paperless Desktop: A desktop UI for your Paperless installation. Runs on Mac, Linux, and Windows. Known issues on Mac: (Could not load reminders and documents)

Important Note

Document scanners are typically used to scan sensitive documents. Things like your social insurance number, tax records, invoices, etc. Everything is stored in the clear without encryption. This means that Paperless should never be run on an untrusted host. Instead, I recommend that if you do want to use it, run it locally on a server in your own home.

展开阅读全文

代码

评论 (0)

加载中
更多评论
暂无内容
发表于大前端专区
2015/03/27 13:55

{{}},ng-bind,ng-model的差别

今天学习遇到个问题,顺便查看了一下:{{}},ng-bind两者的却别在于,{{}}html没有加载完毕{{txt}}回直接显示到页面,直到angular渲染该绑定数据(这种行为有可能将{{binding}}让用户看到,我们不断刷新时既可以看到);而ng-bind则是在angular渲染完毕后将数据显示;ng-model将值绑定到表单元素上,即只用于表单元素; 顺便说下ng-controller 该命令用户管理视图和模型之间的关系的控制器(单页面中可以根据复杂程度引入多个控...

0
0
发表了博客
2020/05/20 02:20

ng-model和ng-bind之间有什么区别 - What's the difference between ng-model and ng-bind

问题: I'm currently learning AngularJS and am having difficulty understanding the difference between ng-bind and ng-model . 我目前正在学习AngularJS,并且很难理解ng-bind和ng-model之间的区别。 Can anyone tell me how they differ and when one should be used over the other? 任何人都可以告诉我他们的差异,以及何时应该使用另一个? 解决方案: 参考一: https://stackoom.com/question/q6uR/ng-model和ng-bi...

0
0
2019/05/31 10:26

angular1.7 ng-options和ng-repeat区别

### ng-options 和ng-repeat 1.ng-options="c.id as c.name for c in fromCities" 这个c.id是number类型的值 用于场景查看详情相对应的值 2.ng-repeat= "item in data" 这个item.id是string类型的值 用于场景一般的列表

0
0
发表了博客
2019/07/24 22:15

ng build --aot 与 ng build --prod

angluar的编译有以下几种方式: ng build 常规的压缩操作 代码体积最大  ng build --aot angular预编译 代码体积较小  ng build --prod angular预编译 代码体积最小,访问速度最快 --prod 默认 开启了--aot ,所以在使用--prod 和 --prod --aot是一样的。 关于JIT和AOT,复制了知乎上的一段话,讲的很好。  JIT和AOT的思想都一样。在JAVA中,JIT(Just In Time即时编译)是运行时优化,AOT(Ahead Of Time)是编译时优化。 ...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
0 评论
0 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部