diff --git a/docs/_static/paperless-0-dashboard.png b/docs/_static/paperless-0-dashboard.png deleted file mode 100755 index 8d86e4c8..00000000 Binary files a/docs/_static/paperless-0-dashboard.png and /dev/null differ diff --git a/docs/_static/paperless-1-list-table.png b/docs/_static/paperless-1-list-table.png deleted file mode 100755 index 94e71511..00000000 Binary files a/docs/_static/paperless-1-list-table.png and /dev/null differ diff --git a/docs/_static/paperless-10-mobile.png b/docs/_static/paperless-10-mobile.png deleted file mode 100755 index 1c78d176..00000000 Binary files a/docs/_static/paperless-10-mobile.png and /dev/null differ diff --git a/docs/_static/paperless-11-mail-filters.png b/docs/_static/paperless-11-mail-filters.png deleted file mode 100644 index d35f4ba8..00000000 Binary files a/docs/_static/paperless-11-mail-filters.png and /dev/null differ diff --git a/docs/_static/paperless-2-list-smallcards.png b/docs/_static/paperless-2-list-smallcards.png deleted file mode 100755 index 43121a79..00000000 Binary files a/docs/_static/paperless-2-list-smallcards.png and /dev/null differ diff --git a/docs/_static/paperless-3-list-largecards.png b/docs/_static/paperless-3-list-largecards.png deleted file mode 100755 index 10923782..00000000 Binary files a/docs/_static/paperless-3-list-largecards.png and /dev/null differ diff --git a/docs/_static/paperless-4-filter.png b/docs/_static/paperless-4-filter.png deleted file mode 100755 index 0bf0550f..00000000 Binary files a/docs/_static/paperless-4-filter.png and /dev/null differ diff --git a/docs/_static/paperless-5-editing.png b/docs/_static/paperless-5-editing.png deleted file mode 100755 index b4fbd33a..00000000 Binary files a/docs/_static/paperless-5-editing.png and /dev/null differ diff --git a/docs/_static/paperless-6-tags.png b/docs/_static/paperless-6-tags.png deleted file mode 100755 index 5da6fe73..00000000 Binary files a/docs/_static/paperless-6-tags.png and /dev/null differ diff --git a/docs/_static/paperless-7-autocomplete.png b/docs/_static/paperless-7-autocomplete.png deleted file mode 100755 index 49e66d18..00000000 Binary files a/docs/_static/paperless-7-autocomplete.png and /dev/null differ diff --git a/docs/_static/paperless-8-search-results.png b/docs/_static/paperless-8-search-results.png deleted file mode 100755 index 1a8ef863..00000000 Binary files a/docs/_static/paperless-8-search-results.png and /dev/null differ diff --git a/docs/_static/paperless-9-admin.png b/docs/_static/paperless-9-admin.png deleted file mode 100755 index aa8b33f9..00000000 Binary files a/docs/_static/paperless-9-admin.png and /dev/null differ diff --git a/docs/_static/screenshots/correspondents.png b/docs/_static/screenshots/correspondents.png new file mode 100644 index 00000000..269543b2 Binary files /dev/null and b/docs/_static/screenshots/correspondents.png differ diff --git a/docs/_static/screenshots/dashboard.png b/docs/_static/screenshots/dashboard.png new file mode 100644 index 00000000..3a3494e7 Binary files /dev/null and b/docs/_static/screenshots/dashboard.png differ diff --git a/docs/_static/screenshots/documents-filter.png b/docs/_static/screenshots/documents-filter.png new file mode 100644 index 00000000..feb0f58d Binary files /dev/null and b/docs/_static/screenshots/documents-filter.png differ diff --git a/docs/_static/screenshots/documents-largecards.png b/docs/_static/screenshots/documents-largecards.png new file mode 100644 index 00000000..d65c4a0d Binary files /dev/null and b/docs/_static/screenshots/documents-largecards.png differ diff --git a/docs/_static/screenshots/documents-smallcards.png b/docs/_static/screenshots/documents-smallcards.png new file mode 100644 index 00000000..77de7a04 Binary files /dev/null and b/docs/_static/screenshots/documents-smallcards.png differ diff --git a/docs/_static/screenshots/documents-table.png b/docs/_static/screenshots/documents-table.png new file mode 100644 index 00000000..a5f2a3d7 Binary files /dev/null and b/docs/_static/screenshots/documents-table.png differ diff --git a/docs/_static/screenshots/editing.png b/docs/_static/screenshots/editing.png new file mode 100644 index 00000000..21a0bcdf Binary files /dev/null and b/docs/_static/screenshots/editing.png differ diff --git a/docs/_static/screenshots/logs.png b/docs/_static/screenshots/logs.png new file mode 100644 index 00000000..10a0d393 Binary files /dev/null and b/docs/_static/screenshots/logs.png differ diff --git a/docs/_static/screenshots/mail-rules-edited.png b/docs/_static/screenshots/mail-rules-edited.png new file mode 100644 index 00000000..68a170ac Binary files /dev/null and b/docs/_static/screenshots/mail-rules-edited.png differ diff --git a/docs/_static/screenshots/mobile.png b/docs/_static/screenshots/mobile.png new file mode 100644 index 00000000..1217f06b Binary files /dev/null and b/docs/_static/screenshots/mobile.png differ diff --git a/docs/_static/screenshots/new-tag.png b/docs/_static/screenshots/new-tag.png new file mode 100644 index 00000000..4ea43853 Binary files /dev/null and b/docs/_static/screenshots/new-tag.png differ diff --git a/docs/_static/screenshots/search-preview.png b/docs/_static/screenshots/search-preview.png new file mode 100644 index 00000000..78925ae1 Binary files /dev/null and b/docs/_static/screenshots/search-preview.png differ diff --git a/docs/_static/screenshots/search-results.png b/docs/_static/screenshots/search-results.png new file mode 100644 index 00000000..f9db1419 Binary files /dev/null and b/docs/_static/screenshots/search-results.png differ diff --git a/docs/administration.rst b/docs/administration.rst index 2bfce958..a77c559f 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -69,7 +69,7 @@ First of all, ensure that paperless is stopped. After that, :ref:`make a 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: diff --git a/docs/screenshots.rst b/docs/screenshots.rst index 2dcb2b60..cf99641c 100644 --- a/docs/screenshots.rst +++ b/docs/screenshots.rst @@ -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 diff --git a/docs/setup.rst b/docs/setup.rst index a43b03aa..af2f47f9 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -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 ` 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