mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
more docs
This commit is contained in:
parent
2ad3087e22
commit
a3aa9ca2dc
@ -9,7 +9,7 @@ Making backups
|
||||
|
||||
.. warning::
|
||||
|
||||
This section is not updated yet.
|
||||
This section is not updated to paperless-ng yet.
|
||||
|
||||
So you're bored of this whole project, or you want to make a remote backup of
|
||||
your files for whatever reason. This is easy to do, simply use the
|
||||
@ -22,6 +22,7 @@ into an arbitrary directory.
|
||||
Restoring
|
||||
=========
|
||||
|
||||
|
||||
.. _administration-updating:
|
||||
|
||||
Updating paperless
|
||||
|
@ -5,7 +5,7 @@ The REST API
|
||||
|
||||
.. warning::
|
||||
|
||||
This section is not updated yet.
|
||||
This section is not updated to paperless-ng yet.
|
||||
|
||||
Paperless makes use of the `Django REST Framework`_ standard API interface
|
||||
because of its inherent awesomeness. Conveniently, the system is also
|
||||
@ -16,8 +16,10 @@ installation.
|
||||
.. _Django REST Framework: http://django-rest-framework.org/
|
||||
|
||||
|
||||
Uploading
|
||||
=========
|
||||
.. _api-file_uploads:
|
||||
|
||||
POSTing Documents
|
||||
=================
|
||||
|
||||
File uploads in an API are hard and so far as I've been able to tell, there's
|
||||
no standard way of accepting them, so rather than crowbar file uploads into the
|
||||
|
@ -3,6 +3,10 @@
|
||||
Contributing to Paperless
|
||||
#########################
|
||||
|
||||
.. warning::
|
||||
|
||||
This section is not updated to paperless-ng yet.
|
||||
|
||||
Maybe you've been using Paperless for a while and want to add a feature or two,
|
||||
or maybe you've come across a bug that you have some ideas how to solve. The
|
||||
beauty of Free software is that you can see what's wrong and help to get it
|
||||
|
@ -3,6 +3,10 @@
|
||||
Extending Paperless
|
||||
===================
|
||||
|
||||
.. warning::
|
||||
|
||||
This section is not updated to paperless-ng yet.
|
||||
|
||||
For the most part, Paperless is monolithic, so extending it is often best
|
||||
managed by way of modifying the code directly and issuing a pull request on
|
||||
`GitHub`_. However, over time the project has been evolving to be a little
|
||||
|
@ -2,6 +2,9 @@
|
||||
Troubleshooting
|
||||
***************
|
||||
|
||||
.. warning::
|
||||
|
||||
This section is not updated to paperless-ng yet.
|
||||
|
||||
Consumer warns ``OCR for XX failed``
|
||||
####################################
|
||||
|
@ -94,15 +94,22 @@ pull emails down from an arbitrary account and dump them into the consumption
|
||||
directory where the consumer will follow the
|
||||
usual pattern on consuming the document.
|
||||
|
||||
Some things you need to know about this feature:
|
||||
.. hint::
|
||||
|
||||
* It's disabled by default. By setting the values below it will be enabled.
|
||||
* It's been tested in a limited environment, so it may not work for you (please
|
||||
submit a pull request if you can!)
|
||||
* It's designed to **delete mail from the server once consumed**. So don't go
|
||||
pointing this to your personal email account and wonder where all your stuff
|
||||
went.
|
||||
* Currently, only one photo (attachment) per email will work.
|
||||
It's disabled by default. By setting the values below it will be enabled.
|
||||
|
||||
It's been tested in a limited environment, so it may not work for you (please
|
||||
submit a pull request if you can!)
|
||||
|
||||
.. danger::
|
||||
|
||||
It's designed to **delete mail from the server once consumed**. So don't go
|
||||
pointing this to your personal email account and wonder where all your stuff
|
||||
went.
|
||||
|
||||
.. hint::
|
||||
|
||||
Currently, only one photo (attachment) per email will work.
|
||||
|
||||
So, with all that in mind, here's what you do to get it running:
|
||||
|
||||
@ -128,7 +135,7 @@ So, with all that in mind, here's what you do to get it running:
|
||||
REST API
|
||||
========
|
||||
|
||||
You can also submit a document using the REST API, see the API section for details.
|
||||
You can also submit a document using the REST API, see :ref:`api-file_uploads` for details.
|
||||
|
||||
.. _usage-recommended_workflow:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user