paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

found some additional bits to yours

Browse Source
This commit is contained in:
Tido- 2017-05-03 22:20:13 +02:00
parent 58cbfeb72a
commit 02730be871
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.rst
View File

@ -6,7 +6,7 @@ Paperless
|Travis| |Travis|
|Dependencies| |Dependencies|
Index and archive all of your scaned paper documents Index and archive all of your scanned paper documents
I hate paper. Environmental issues aside, it's a tech person's nightmare: I hate paper. Environmental issues aside, it's a tech person's nightmare:
@ -23,18 +23,19 @@ it... because paper. I wrote this to make my life easier.
How it Works How it Works
============ ============
1. Paperless does not run your scanner. Paperless does not control your scanner, it only helps you deal with what your
2. Buy a document scanner like `this one`_ (used by me) or `this other one`_ scanner produces
1. Buy a document scanner like `this one`_ (used by me) or `this other one`_
recommended by another user. recommended by another user.
3. Set it up to "scan to FTP" or something similar. It should be able to push 2. 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. If your scanned images to a server without you having to do anything. If your
scanner doesn't know how to automatically upload the file somewhere, you can 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 always do that manually. Paperless doesn't care how the documents get into
its local consumption directory. its local consumption directory.
4. Have the target server run the Paperless consumption script to OCR the file 3. Have the target server run the Paperless consumption script to OCR the file
and index it into a local database. and index it into a local database.
5. Use the web frontend to sift through the database and find what you want. 4. Use the web frontend to sift through the database and find what you want.
6. Download the PDF you need/want via the web interface and do whatever you 5. 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. 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. In most cases, no one will care or notice.
@ -83,9 +84,9 @@ Similar Projects
There's another project out there called `Mayan EDMS`_ that has a surprising There's another project out there called `Mayan EDMS`_ that has a surprising
amount of technical overlap with Paperless. Also based on Django and using amount of technical overlap with Paperless. Also based on Django and using
a consumer model with Tesseract and unpaper, Mayan EDMS is *much* more a consumer model with Tesseract and Unpaper, Mayan EDMS is *much* more
featureful and comes with a slick UI as well, but still in Python 2. It may be featureful and comes with a slick UI as well, but still in Python 2. It may be
that Paperless consumes less resources, but to be honest, this is just a guess that Paperless consumes fewer resources, but to be honest, this is just a guess
as I haven't tested this myself. One thing's for certain though, *Paperless* as I haven't tested this myself. One thing's for certain though, *Paperless*
is a **much** better name. is a **much** better name.
@ -94,11 +95,11 @@ Important Note
============== ==============
Document scanners are typically used to scan sensitive documents. Things like Document scanners are typically used to scan sensitive documents. Things like
your social insurance number, tax records, invoices, etc. While paperless your social insurance number, tax records, invoices, etc. While Paperless
encrypts the original files via the consumption script, the OCR'd text is *not* encrypts the original files via the consumption script, the OCR'd text is *not*
encrypted and is therefore stored in the clear (it needs to be searchable, so encrypted and is therefore stored in the clear (it needs to be searchable, so
if someone has ideas on how to do that on encrypted data, I'm all ears). This if someone has ideas on how to do that on encrypted data, I'm all ears). This
means that paperless should never be run on an untrusted host. Instead, I 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 recommend that if you do want to use it, run it locally on a server in your own
home. home.