2020-11-13 19:27:22 +01:00
|
|
|
*********
|
2016-01-24 20:15:50 -05:00
|
|
|
Paperless
|
2020-11-13 19:27:22 +01:00
|
|
|
*********
|
2016-01-24 20:15:50 -05:00
|
|
|
|
2017-11-01 11:15:37 +00:00
|
|
|
Paperless is a simple Django application running in two parts:
|
2020-11-13 18:46:19 +01:00
|
|
|
a *Consumer* (the thing that does the indexing) and
|
|
|
|
|
the *Web server* (the part that lets you search &
|
2018-02-03 15:26:09 +00:00
|
|
|
download already-indexed documents). If you want to learn more about its
|
|
|
|
|
functions keep on reading after the installation section.
|
2016-01-24 20:15:50 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Why This Exists
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
Paper is a nightmare. Environmental issues aside, there's no excuse for it in
|
2018-02-03 15:26:09 +00:00
|
|
|
the 21st century. It takes up space, collects dust, doesn't support any form
|
|
|
|
|
of a search feature, indexing is tedious, it's heavy and prone to damage &
|
|
|
|
|
loss.
|
2016-01-24 20:15:50 -05:00
|
|
|
|
2017-11-01 11:15:37 +00:00
|
|
|
I wrote this to make "going paperless" easier. I do not have to worry about
|
2018-02-03 15:26:09 +00:00
|
|
|
finding stuff again. I feed documents right from the post box into the scanner
|
|
|
|
|
and then shred them. Perhaps you might find it useful too.
|
2017-05-10 22:25:59 +02:00
|
|
|
|
|
|
|
|
|
2020-11-13 18:46:19 +01:00
|
|
|
Paperless-ng
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
I wanted to make big changes to the project that will impact the way it is used
|
|
|
|
|
by its users greatly. Among the users who currently use paperless in production
|
|
|
|
|
there are probably many that don't want these changes right away. I also wanted
|
|
|
|
|
to have more control over what goes into the code and what does not. Therefore,
|
|
|
|
|
paperless-ng was created. NG stands for both Angular (the framework used for the
|
|
|
|
|
Frontend) and next-gen. Publishing this project under a different name also
|
|
|
|
|
avoids confusion between paperless and paperless-ng.
|
|
|
|
|
|
|
|
|
|
It would be great if this project could eventually merge back into the main
|
|
|
|
|
repository, but it needs a lot more work before that can happen.
|
2016-01-24 20:15:50 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Contents
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
2020-11-13 18:46:19 +01:00
|
|
|
:maxdepth: 1
|
2016-01-24 20:15:50 -05:00
|
|
|
|
|
|
|
|
setup
|
2020-11-13 18:46:19 +01:00
|
|
|
usage_overview
|
|
|
|
|
advanced_usage
|
|
|
|
|
administration
|
2020-11-13 20:43:16 +01:00
|
|
|
configuration
|
2016-03-05 00:01:09 +00:00
|
|
|
api
|
2020-11-13 20:52:09 +01:00
|
|
|
faq
|
2018-02-03 15:30:58 +00:00
|
|
|
extending
|
2016-03-28 14:54:09 +01:00
|
|
|
troubleshooting
|
2018-09-22 16:22:03 +01:00
|
|
|
contributing
|
2017-11-01 11:15:37 +00:00
|
|
|
scanners
|
2020-11-14 01:21:52 +01:00
|
|
|
screenshots
|
2016-01-24 20:15:50 -05:00
|
|
|
changelog
|
