docs, screenshots
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-0-dashboard.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 52 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-1-list-table.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 62 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-10-mobile.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 56 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-11-mail-filters.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 70 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-2-list-smallcards.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 256 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-3-list-largecards.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 224 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-4-filter.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 101 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-5-editing.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 196 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-6-tags.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 50 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-7-autocomplete.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 53 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-8-search-results.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 214 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/paperless-9-admin.png
									
									
									
									
										vendored
									
									
								
							
							
						
						| 
		 Before Width: | Height: | Size: 50 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/correspondents.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 106 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/dashboard.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 167 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/documents-filter.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 28 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/documents-largecards.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 306 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/documents-smallcards.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 410 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/documents-table.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 137 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/editing.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 293 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/logs.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 260 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/mail-rules-edited.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 96 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/mobile.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 158 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/new-tag.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 32 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/search-preview.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 61 KiB  | 
							
								
								
									
										
											BIN
										
									
								
								docs/_static/screenshots/search-results.png
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						| 
		 After Width: | Height: | Size: 261 KiB  | 
@@ -69,7 +69,7 @@ First of all, ensure that paperless is stopped.
 | 
			
		||||
 | 
			
		||||
After that, :ref:`make a backup <administration-backup>`.
 | 
			
		||||
 | 
			
		||||
A.  If you used the docker-compose file, simply download the files of the new release,
 | 
			
		||||
A.  If you used the dockerfiles archive, simply download the files of the new release,
 | 
			
		||||
    adjust the settings in the files (i.e., the path to your consumption directory),
 | 
			
		||||
    and replace your existing docker-compose files. Then start paperless as usual,
 | 
			
		||||
    which will pull the new image, and update your database, if necessary:
 | 
			
		||||
 
 | 
			
		||||
@@ -9,41 +9,37 @@ research papers though, its a horrible tool for that job.
 | 
			
		||||
 | 
			
		||||
The dashboard shows customizable views on your document and allows document uploads:
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-0-dashboard.png
 | 
			
		||||
.. image:: _static/screenshots/dashboard.png
 | 
			
		||||
 | 
			
		||||
The document list provides three different styles to scroll through your documents:
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-1-list-table.png
 | 
			
		||||
.. image:: _static/paperless-2-list-smallcards.png
 | 
			
		||||
.. image:: _static/paperless-3-list-largecards.png
 | 
			
		||||
.. image:: _static/screenshots/documents-table.png
 | 
			
		||||
.. image:: _static/screenshots/documents-smallcards.png
 | 
			
		||||
.. image:: _static/screenshots/documents-largecards.png
 | 
			
		||||
 | 
			
		||||
Extensive filtering mechanisms:
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-4-filter.png
 | 
			
		||||
.. image:: _static/screenshots/documents-filter.png
 | 
			
		||||
 | 
			
		||||
Side-by-side editing of documents. Optmized for 1080p.
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-5-editing.png
 | 
			
		||||
.. image:: _static/screenshots/editing.png
 | 
			
		||||
 | 
			
		||||
Tag editing. This looks about the same for correspondents and document types.
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-6-tags.png
 | 
			
		||||
.. image:: _static/screenshots/new-tag.png
 | 
			
		||||
 | 
			
		||||
Searching provides auto complete and highlights the results.
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-7-autocomplete.png
 | 
			
		||||
.. image:: _static/paperless-8-search-results.png
 | 
			
		||||
 | 
			
		||||
The old admin is still there and accessible!
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-9-admin.png
 | 
			
		||||
.. image:: _static/screenshots/search-preview.png
 | 
			
		||||
.. image:: _static/screenshots/search-results.png
 | 
			
		||||
 | 
			
		||||
Fancy mail filters!
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-11-mail-filters.png
 | 
			
		||||
.. image:: _static/screenshots/mail-rules-edited.png
 | 
			
		||||
 | 
			
		||||
Mobile support in the future? This kinda works, however some layouts are still
 | 
			
		||||
too wide.
 | 
			
		||||
 | 
			
		||||
.. image:: _static/paperless-10-mobile.png
 | 
			
		||||
.. image:: _static/screenshots/mobile.png
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -102,8 +102,7 @@ Paperless consists of the following components:
 | 
			
		||||
    for getting the tasks from the webserver and consumer to the task scheduler. These run in different
 | 
			
		||||
    processes (maybe even on different machines!), and therefore, this is necessary.
 | 
			
		||||
 | 
			
		||||
*   A database server. Paperless supports PostgreSQL and sqlite for storing its data. However, with the
 | 
			
		||||
    added concurrency, it is strongly advised to use PostgreSQL, as sqlite has its limits in that regard.
 | 
			
		||||
*   Optional: A database server. Paperless supports both PostgreSQL and SQLite for storing its data.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
Installation
 | 
			
		||||
@@ -146,10 +145,10 @@ Docker Route
 | 
			
		||||
 | 
			
		||||
    .. hint::
 | 
			
		||||
 | 
			
		||||
        For new installations, it is recommended to use postgresql as the database
 | 
			
		||||
        backend. This is due to the increased amount of concurrency in paperless-ng.
 | 
			
		||||
        For new installations, it is recommended to use PostgreSQL as the database
 | 
			
		||||
        backend.
 | 
			
		||||
 | 
			
		||||
2.  Modify ``docker-compose.yml`` to your preferences. You should change the path
 | 
			
		||||
2.  Modify ``docker-compose.yml`` to your preferences. You may want to change the path
 | 
			
		||||
    to the consumption directory in this file. Find the line that specifies where
 | 
			
		||||
    to mount the consumption directory:
 | 
			
		||||
 | 
			
		||||
@@ -221,10 +220,10 @@ things have changed under the hood, so you need to adapt your setup depending on
 | 
			
		||||
how you installed paperless. The important things to keep in mind are as follows.
 | 
			
		||||
 | 
			
		||||
* Read the :ref:`changelog <paperless_changelog>` and take note of breaking changes.
 | 
			
		||||
* It is recommended to use postgresql as the database now. If you want to continue
 | 
			
		||||
  using SQLite, which is the default of paperless, use ``docker-compose.sqlite.yml``.
 | 
			
		||||
  See :ref:`setup-sqlite_to_psql` for details on how to move your data from
 | 
			
		||||
  sqlite to postgres.
 | 
			
		||||
* You should decide if you want to stick with SQLite or want to migrate your database
 | 
			
		||||
  to PostgreSQL. See :ref:`setup-sqlite_to_psql` for details on how to move your data from
 | 
			
		||||
  SQLite to PostgreSQL. Both work fine with paperless. However, if you already have a
 | 
			
		||||
  database server running for other services, you might as well use it for paperless as well.
 | 
			
		||||
* The task scheduler of paperless, which is used to execute periodic tasks
 | 
			
		||||
  such as email checking and maintenance, requires a `redis`_ message broker
 | 
			
		||||
  instance. The docker-compose route takes care of that.
 | 
			
		||||
@@ -259,7 +258,7 @@ Migration to paperless-ng is then performed in a few simple steps:
 | 
			
		||||
        will be incompatible with the migrated volumes.
 | 
			
		||||
 | 
			
		||||
4.  Copy the ``docker-compose.sqlite.yml`` file to ``docker-compose.yml``.
 | 
			
		||||
    If you want to migrate to PostgreSQL, do that after you migrated your existing
 | 
			
		||||
    If you want to switch to PostgreSQL, do that after you migrated your existing
 | 
			
		||||
    SQLite database.
 | 
			
		||||
 | 
			
		||||
5.  Adjust ``docker-compose.yml`` and
 | 
			
		||||
@@ -299,7 +298,7 @@ management commands as below.
 | 
			
		||||
 | 
			
		||||
.. caution::
 | 
			
		||||
 | 
			
		||||
    Make sure that your sqlite database is migrated to the latest version.
 | 
			
		||||
    Make sure that your SQLite database is migrated to the latest version.
 | 
			
		||||
    Starting paperless will make sure that this is the case. If your try to
 | 
			
		||||
    load data from an old database schema in SQLite into a newer database
 | 
			
		||||
    schema in PostgreSQL, you will run into trouble.
 | 
			
		||||
@@ -367,6 +366,7 @@ Considerations for less powerful devices
 | 
			
		||||
Paperless runs on Raspberry Pi. However, some things are rather slow on the Pi and 
 | 
			
		||||
configuring some options in paperless can help improve performance immensely:
 | 
			
		||||
 | 
			
		||||
*   Stick with SQLite to save some resources.
 | 
			
		||||
*   Consider setting ``PAPERLESS_OCR_PAGES`` to 1, so that paperless will only OCR
 | 
			
		||||
    the first page of your documents.
 | 
			
		||||
*   ``PAPERLESS_TASK_WORKERS`` and ``PAPERLESS_THREADS_PER_WORKER`` are configured
 | 
			
		||||
 
 | 
			
		||||