Update changelog and fix some docs

This commit is contained in:
Eike Kettner
2021-02-19 00:53:04 +01:00
parent f04763347d
commit 324ceb0cd5
5 changed files with 69 additions and 10 deletions

View File

@ -14,7 +14,7 @@ mktoc = true
Everything, including all files, are stored in the database.
Now that seems to put off some people coming to Docspell, so here are
some thoughts on why this is and why is may be not such a big deal. It
some thoughts on why this is and why it may be not such a big deal. It
was a conscious decision and the option to hold all files in the file
system was considered, but not chosen in the end.
@ -36,7 +36,7 @@ were the reasons for the current decision:
system used by the application and not two which reduces complexity
in the code.
- Consistency: Both "databases" (filesystem + relational db) can
easily get out of sync and this will break the application. It's
easily get out of sync and this will break the application. It's a
very strong plus to be able to rely on the strong ACID guarantees of
database systems.
- Distributed/Scaling: One goal is to run Docspell in a distributed

View File

@ -31,9 +31,12 @@ description = "A list of features and limitations."
[REST Api](@/docs/api/_index.md); allows to [generate
clients](https://openapi-generator.tech/docs/generators) for
(almost) any language
- mobile-friendly Web-UI
- [Create “share-urls”](@/docs/webapp/uploading.md#anonymous-upload)
to upload files anonymously
- mobile-friendly Web-UI with dark and light theme
- [Create anonymous
“upload-urls”](@/docs/webapp/uploading.md#anonymous-upload) to
upload files; these urls allow to be configured with metadata like
tags, folder etc that are applied to all files uploaded through this
url
- [Send documents via e-mail](@/docs/webapp/mailitem.md)
- [E-Mail notification](@/docs/webapp/notifydueitems.md) for documents
with due dates

View File

@ -18,11 +18,14 @@ package manager or see [this site](https://adoptopenjdk.net/) for
other options.
It is enough to install the JRE. The JDK is required, if you want to
build docspell from source.
build docspell from source. For newer versions, the JRE is not shipped
anymore, simply use JDK then.
Docspell has been tested with Java version 1.8 (or sometimes referred
to as JRE 8 and JDK 8, respectively). The pre-build packages are also
build using JDK 8. But a later version of Java should work as well.
to as JRE 8 and JDK 8, respectively). The pre-build packages are build
using JDK 8. So at least a JDK/JRE 8 is required. However, it also
works on newer java versions, I recommend JDK 11 as this has better
default options. The provided docker images use JDK11, too.
The next tools are only required on machines running the *Joex*
component.

View File

@ -10,8 +10,8 @@ mktoc = true
When uploading a file, it is only saved to the database together with
the given meta information. The file is not visible in the ui yet.
Then joex takes the next such file (or files in case you uploaded
many) and starts processing it. When processing finished, it the item
and its files will show up in the ui.
many) and starts processing it. When processing finished, the item and
its files will show up in the ui.
If an error occurs during processing, the item will be created
anyways, so you can see it. Depending on the error, some information