Update documentation

website/site/content/docs/feed/_index.md

@@ -32,7 +32,7 @@ This requires to login at the webapp. Since this is complicated from
 other applications, you can create custom hard-to-guess endpoints to
 use with the following options.
 
-# Watch Directories
+# Scanners / Watch Directories
 
 If you have a (document) scanner (or think about getting one), it can
 usually be configured to place scanned documents as image or PDF files
@@ -45,6 +45,12 @@ you can organize the files as you want in there (rename, move etc).
 The scanner should support 300dpi for better results. Docspell
 converts the files into PDF adding a text layer of image-only files.
 
+Check out
+[scanadf2docspell](https://github.com/eresturo/scanadf2docspell) if
+your scanner is connected to your computer. This can create nice pdf
+files from scanners with ADF, applying corrections and sending them to
+docspell.
+
 {{ buttonright(classes="is-primary ", href="/docs/tools/consumedir", text="More") }}
 
 

website/site/content/docs/install/running.md

@@ -64,3 +64,12 @@ $ ./docspell-restserver*/bin/docspell-restserver -h
 ```
 
 gives an overview of supported options.
+
+It is recommended to run joex with 1.5G heap space or more and with
+the G1GC enabled. If you use java8, you need to add an option to use
+G1GC, for java11 this is not necessary (but doesn't hurt either). This
+could look like this:
+
+```
+./docspell-joex-{{version()}}/bin/docspell-joex -J-Xmx1596M -J-XX:+UseG1GC -- /path/to/joex.conf
+```

website/site/content/docs/webapp/customfields.md

@@ -113,8 +113,8 @@ Then you can set values that are matched against your items.
 </div>
 
 Values are also validated in the search form. Only valid values are
-sent to the server for searching. For most fields you can use a
+sent to the server for searching. There is one exception: you can use
-wildcard at beginning and/or end to do a substring match:
+a wildcard at beginning and/or end to do a substring match:
 
 {{ figure(file="custom-fields-07.png") }}
 
@@ -126,3 +126,5 @@ this is text-based matching.
     {{ figure(file="custom-fields-08.png") }}
     </div>
 </div>
+
+Using a single `*` allows to find items that have any value set.

website/site/content/docs/webapp/finding.md

@@ -67,6 +67,20 @@ Clicking the checkbox "Only new" shows items that have not been
 "Confirmed". All items that have been created by docspell and not
 looked at are marked as "new" automatically.
 
+## Fulltext and Name Search
+
+You can choose tags or correspondents in the search menu and further
+restrict the results using full text search with the *content* field.
+
+If this is the only filled field, then a normal fulltext search is
+done. It is exactly the same as filling out the *Contents Only* search
+bar. However, if some other fields are also set, then first a search
+using all other fields is done and these results are then further
+constraint by a fulltext search.
+
+You can switch to "Name Search" using the little icon on the right.
+This will then only search in item names and notes.
+
 ## Tags & Tag Categories
 
 Click on a tag to show only items with this tag, the tag is marked
@@ -121,25 +135,12 @@ Pick a correspondent to show only these items.
 
 Pick a concerned entity to show only these items.
 
-## Names
+## Custom Fields
 
-Searches in names of certain properties. The `Names` field is the same
+You can choose one or more custom field to search for. You can use
-as the search in the search bar ([see above](#names)).
+wildcards (`*`) at the beginning and/or end of a search term, too. To
+find items that have any value, use a single `*`.
 
-## Content
-
-You can choose tags or correspondents in the search menu and further
-restrict the results using full text search with the *content* field.
-
-{% infobubble(mode="warning", title="Please note") %}
-This field is intended to be used in conjunction with other fields in
-the search menu. It *may be really slow* if used alone, since first
-the database query is executed and its results are further constrained
-by fulltext search.
-
-Use the search-bar with option *Contents Only* to do quick fulltext
-searches.
-{% end %}
 
 ## Date
 

website/site/content/docs/webapp/itemcard-customize.md

@@ -28,7 +28,7 @@ The item preview is an image of the first page of the first
 attachment. You can change the order of attachments in the item detail
 view. This image has a predefined size, which is specified [docspell's
 configuration](@/docs/configure/_index.md#joex) (see
-`extraction.preview.dpi`). The size used to display it, can be
+`extraction.preview.dpi`). The size for displaying it, can be
 specified via this setting. A _small_ preview uses about 80px width, a
 _medium_ one 160px and _large_ means to use the available space in the
 card.

website/site/content/docs/webapp/metadata.md

@@ -18,6 +18,7 @@ known meta data. The *Meta Data* page allows to manage this meta data:
 - Persons
 - Equipments
 - Folders
+- Custom Fields
 
 ## Tags
 

website/site/content/docs/webapp/notifydueitems.md

@@ -12,6 +12,8 @@ list of items, sorted by their due date.
 You need first define smtp settings, please see [this
 page](@/docs/webapp/emailsettings.md#smtp-settings).
 
+## Settings
+
 Notifying works simply by searching for due items periodically. It
 will be submitted to the job queue and is picked up by an available
 [job executor](@/docs/joex/_index.md) eventually. This can be setup in
@@ -72,3 +74,9 @@ periodically.
 
 You can see the task executing at the [processing
 page](@/docs/webapp/processing.md).
+
+
+## Configuration
+
+The part `docspell.joex.send-mail.list-id` can be used to add a
+`List-Id` mail header to every notification mail.

website/site/content/docs/webapp/scanmailbox.md

@@ -51,6 +51,13 @@ deleted and not moved to your trash folder*. If both options are off,
 nothing happens with that mail, it simply stays (and could be re-read
 on the next run).
 
+Be careful when mails are neither moved nor deleted after processing.
+They could be selected anew in the next run, meaning that the job can
+not progress, because it filters out the same mails all the time. You
+can however, simply schedule the task in an interval >= the `Received
+Since Hours` setting.
+
+
 ## Filtering
 
 The following properties allow to filter mails that are imported.
@@ -111,6 +118,20 @@ like this: `1/7` which is the same as a list with `1` and all
 multiples of `7` added to it. In other words, it matches `1`, `1+7`,
 `1+7+7`, `1+7+7+7` and so on.
 
+# Configuraion
+
+The admin can tweak some properties in the config file at
+`docspell.joex.user-tasks.scan-mailbox`:
+
+- `max-folders`: Maximum number of folders to scan. This sets a hard
+  limit on the folder selection of the user settings.
+- `mail-chunk-size`: the batch size to use when fetching mails; after
+  this many mails have been processed, the connection is
+  re-established to get the next `mail-chunk-size` mails.
+- `max-mails`: the maximum amount of mails to process in one job run.
+  If the mailbox contains more than this amount of mails, it must be
+  waited for the next scheduled executon.
+
 
 # Reading Mails twice / Duplicates