Merge branch 'dev'

.github/workflows/ci.yml

@@ -208,7 +208,7 @@ jobs:
           tag_name: ng-${{ steps.get_version.outputs.version }}
           release_name: Paperless-ng ${{ steps.get_version.outputs.version }}
           draft: false
-          prerelease: true
+          prerelease: false
           body: |
             For a complete list of changes, see the changelog at https://paperless-ng.readthedocs.io/en/latest/changelog.html.
       -

crowdin.yml

@@ -0,0 +1,5 @@
+files:
+  - source: /src/locale/en-us/LC_MESSAGES/django.po
+    translation: /src/locale/%two_letters_code%/LC_MESSAGES/django.po
+  - source: /src-ui/messages.xlf
+    translation: /src-ui/src/locale/messages.%two_letters_code%.xlf

docker/docker-entrypoint.sh

@@ -79,7 +79,11 @@ initialize() {
 		fi
 	done
 
+	echo "creating directory /tmp/paperless"
+	mkdir -p /tmp/paperless
+
 	chown -R paperless:paperless ../
+	chown -R paperless:paperless /tmp/paperless
 
 	migrations
 

docs/administration.rst

@@ -20,6 +20,8 @@ Options available to any installation of paperless:
     metadata to a specific folder. You may import your documents into a
     fresh instance of paperless again or store your documents in another
     DMS with this export.
+*   The document exporter is also able to update an already existing export.
+    Therefore, incremental backups with ``rsync`` are entirely possible.
 
 Options available to docker installations:
 
@@ -88,10 +90,28 @@ B.  If you built the image yourself, do the following:
         $ docker-compose build
         $ docker-compose up
 
-Running `docker-compose up` will also apply any new database migrations.
+Running ``docker-compose up`` will also apply any new database migrations.
 If you see everything working, press CTRL+C once to gracefully stop paperless.
 Then you can start paperless-ng with ``-d`` to have it run in the background.
 
+    .. note::
+
+        In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the
+        docker-compose files specified exact versions and pull won't automatically
+        update to newer versions. In order to enable updates as described above, either
+        get the new ``docker-compose.yml`` file from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
+        or edit the ``docker-compose.yml`` file, find the line that says
+
+            .. code::
+
+                image: jonaswinkler/paperless-ng:0.9.x
+        
+        and replace the version with ``latest``:
+
+            .. code::
+
+                image: jonaswinkler/paperless-ng:latest
+        
 Bare Metal Route
 ================
 
@@ -192,8 +212,13 @@ backup or migration to another DMS.
 
 .. code::
 
-    document_exporter target
+    document_exporter target [-c] [-f] [-d]
 
+    optional arguments:
+    -c, --compare-checksums
+    -f, --use-filename-format
+    -d, --delete
+    
 ``target`` is a folder to which the data gets written. This includes documents,
 thumbnails and a ``manifest.json`` file. The manifest contains all metadata from
 the database (correspondents, tags, etc).
@@ -202,6 +227,24 @@ When you use the provided docker compose script, specify ``../export`` as the
 target. This path inside the container is automatically mounted on your host on
 the folder ``export``.
 
+If the target directory already exists and contains files, paperless will assume
+that the contents of the export directory are a previous export and will attempt
+to update the previous export. Paperless will only export changed and added files.
+Paperless determines whether a file has changed by inspecting the file attributes
+"date/time modified" and "size". If that does not work out for you, specify
+``--compare-checksums`` and paperless will attempt to compare file checksums instead.
+This is slower.
+
+Paperless will not remove any existing files in the export directory. If you want
+paperless to also remove files that do not belong to the current export such as files
+from deleted documents, specify ``--delete``. Be careful when pointing paperless to
+a directory that already contains other files.
+
+The filenames generated by this command follow the format
+``[date created] [correspondent] [title].[extension]``.
+If you want paperless to use ``PAPERLESS_FILENAME_FORMAT`` for exported filenames
+instead, specify ``--use-filename-format``.
+
 
 .. _utilities-importer:
 

docs/changelog.rst

@@ -5,6 +5,29 @@
 Changelog
 *********
 
+paperless-ng 1.0.0
+##################
+
+Nothing special about this release, but since there are relatively few bug reports coming in, I think that this is reasonably stable.
+
+* Document export
+
+  * The document exporter has been rewritten to support updating an already existing export in place.
+    This enables incremental backups with ``rsync``.
+  * The document exporter supports naming exported files according to ``PAPERLESS_FILENAME_FORMAT``.
+  * The document exporter locks the media directory and the database during execution to ensure that
+    the resulting export is consistent.
+  * See the :ref:`updated documentation <utilities-exporter>` for more details.
+
+* Other changes and additions
+
+  * Added a language selector to the settings.
+  * Added date format options to the settings.
+  * Range selection with shift clicking is now possible in the document list.
+  * Filtering correspondent, type and tag management pages by name.
+  * Focus "Name" field in dialogs by default.
+
+
 paperless-ng 0.9.14
 ###################
 
@@ -116,7 +139,7 @@ paperless-ng 0.9.10
   * There are some configuration options in the settings to alter the behavior.
 
 * Other changes and additions
-  
+
   * Thanks to `zjean`_, paperless now publishes a webmanifest, which is useful for adding the application to home screens on mobile devices.
   * The Paperless-ng logo now navigates to the dashboard.
   * Filter for documents that don't have any correspondents, types or tags assigned.
@@ -136,7 +159,7 @@ paperless-ng 0.9.10
   The bulk delete operations did not update the search index. Therefore, documents that you deleted remained in the index and
   caused the search to return messages about missing documents when searching. Further bulk operations will properly update
   the index.
-  
+
   However, this change is not retroactive: If you used the delete method of the bulk editor, you need to reindex your search index
   by :ref:`running the management command document_index with the argument reindex <administration-index>`.
 
@@ -191,12 +214,12 @@ paperless-ng 0.9.7
 
   * Thanks to the hard work of `Michael Shamoon`_, paperless now comes with a much more streamlined UI for
     filtering documents.
-  
+
   * `Michael Shamoon`_ replaced the document preview with another component. This should fix compatibility with Safari browsers.
 
   * Added buttons to the management pages to quickly show all documents with one specific tag, correspondent, or title.
-  
-  * Paperless now stores your saved views on the server and associates them with your user account. 
+
+  * Paperless now stores your saved views on the server and associates them with your user account.
     This means that you can access your views on multiple devices and have separate views for different users.
     You will have to recreate your views.
 
@@ -214,7 +237,7 @@ paperless-ng 0.9.7
     This option enables you to be logged in into multiple instances by specifying different cookie names for each instance.
 
 * Fixes
-  
+
   * Sometimes paperless would assign dates in the future to newly consumed documents.
   * The filename format fields ``{created_month}`` and ``{created_day}`` now use a leading zero for single digit values.
   * The filename format field ``{tags}`` can no longer be used without arguments.