paperless-ngx/docs/index.rst

49 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2016-01-24 20:15:50 -05:00
.. _index:
Paperless
=========
Paperless is a simple Django application running in two parts:
a :ref:`consumer <utilities-consumer>` (the thing that does the indexing) and
2018-02-03 15:26:09 +00:00
the :ref:`webserver <utilities-webserver>` (the part that lets you search &
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
.. _index-why-this-exists:
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
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
2016-01-24 20:15:50 -05:00
Contents
========
.. toctree::
:maxdepth: 2
requirements
setup
2016-02-14 00:10:49 +00:00
consumption
2016-03-05 00:01:09 +00:00
api
2016-01-24 20:15:50 -05:00
utilities
guesswork
2016-02-11 12:25:00 +00:00
migrating
2018-07-08 16:06:57 +01:00
customising
2018-02-03 15:30:58 +00:00
extending
troubleshooting
2018-09-22 16:22:03 +01:00
contributing
scanners
2016-01-24 20:15:50 -05:00
changelog