docspell/Changelog.md

191 lines
6.7 KiB
Markdown
Raw Normal View History

2020-02-27 22:58:43 +00:00
# Changelog
2020-05-22 21:49:07 +00:00
## v0.6.0
*Unknown*
- New feature "Scan Mailboxes". Docspell can now read mailboxes
periodically to import your mails.
2020-05-23 12:27:56 +00:00
- New feature "Integration Endpoint". Allows an admin to upload files
to any collective using a separate endpoint.
2020-05-22 21:49:07 +00:00
- Fix the `find-by-checksum` route that, given a sha256 checksum,
returns whether there is such a file in docspell. It falsely
returned `false` although documents existed.
- Amend the mail-to-pdf conversion to include the e-mail date.
- Fix webapp for mobile devices.
- The document list on the front-page has been rewritten. The table is
removed and documents are now presented in a “card view”.
- Fix the search menu to remember dates in fields. When going back
from an item detail to the front-page, the search menu remembers the
last state, but dates were cleared.
- More fixes regarding character encodings when reading e-mails.
### Configuration Changes
2020-05-23 12:27:56 +00:00
The joex and rest-server component have new config sections:
2020-05-22 21:49:07 +00:00
- Add `docspell.joex.mail-debug` flag to enable debugging e-mail
related code. This is only useful if you encounter problems
connecting to mail servers.
- Add `docspell.joex.user-tasks` with a `scan-mailbox` section to
configure the new scan-mailbox user task.
- Add `docspell.joex.files` section that is the same as the
corresponding section in the rest server config.
2020-05-23 12:27:56 +00:00
- Add `docspell.rest-server.integration-endpoint` with sub-sections to
configure an endpoint for uploading files for admin users.
2020-05-22 21:49:07 +00:00
### REST Api Changes
- Change `/sec/email/settings` to `/sec/email/settings/smtp`
- Add `/sec/email/settings/imap`
- Add `/sec/usertask/scanmailbox` routes to configure one or more
scan-mailbox tasks
2020-05-23 12:27:56 +00:00
- The data used in `/sec/collective/settings` was extended with a
boolean value to enable/disable the "integration endpoint" for a
collective.
2020-05-22 21:49:07 +00:00
2020-03-28 22:49:15 +00:00
## v0.5.0
2020-04-30 20:01:22 +00:00
*May 1st, 2020*
2020-03-28 22:49:15 +00:00
2020-04-26 21:04:03 +00:00
- Allow to delete attachments of an item.
2020-04-21 21:09:29 +00:00
- Allow to be notified via e-mail for items with a due date. This uses
the periodic-task framework introduced in the last release.
2020-04-17 22:26:41 +00:00
- Fix issues when converting HTML with unkown links. This especially
happens with e-mails that contain images to attachments.
- Fix various issues when importing e-mail files, for example:
2020-04-17 22:26:41 +00:00
- fixes encoding problems for mails without explicit transfer encoding
- add meta info (from, to, subject) to the converted pdf document
- clean html mails to remove unwanted content (like javascript)
- Fix classpath issue with javax.mail vs jakarta.mail
2020-03-28 22:49:15 +00:00
### Configuration Changes
The Joex component has config changes:
- A new section `send-mail` containing a `List-Id` e-mail header to
use. Use an empty string (the default) to avoid setting such header.
This header is only applied for notification mails.
## v0.4.0
2020-03-28 15:35:28 +00:00
*Mar. 29, 2020*
2020-03-20 22:01:50 +00:00
- Support for archive files. Archives, for example zip files, contain
the files that should go into docspell. Docspell now extracts
archives and adds the content to an item. The extraction process is
recursive, so there may be zip files in zip files. File types
supported:
- `zip` every file inside is added to one item as attachment
- `eml` (RCF822 E-Mail files) E-mails are considered archives, since
they may contain multiple files (body and attachments).
- Periodic Tasks framework: Docspell can now run tasks periodically
based on a schedule. This is not yet exposed to the user, but there
are some system cleanup jobs to start with.
- Improvement of the text analysis. For my test files there was a
increase in accuracy by about 10%.
2020-03-20 22:01:50 +00:00
- A due date that is found during text analysis is now set on the
item. If multiple due dates are found, the earliest one is used.
- Allow to switch between viewerjs PDF viewer or the browser's builtin
viewer.
2020-03-27 18:47:55 +00:00
- Bug fixes related to handling text files.
2020-03-27 21:58:36 +00:00
- Add a configurable length limit for text analysis
2020-03-22 20:39:17 +00:00
### Configuration Changes
The configuration of the joex component has been changed.
- new section `docspell.joex.periodic-scheduler` for configuring the
periodic scheduler
- new section `docspell.joex.house-keeping` for configuring
house-keeping tasks
2020-03-27 21:58:36 +00:00
- new section `docspell.joex.text-analysis` for configuring the new
size limit
2020-03-27 18:47:55 +00:00
- The command for running `wkhtmltopdf` changed in that the encoding
is now added at runtime.
2020-03-22 20:39:17 +00:00
### REST Api Changes
The REST Api has some additions:
- new route to retrieve the archive file
- add field in `ItemDetail` data that refers to the archive files of
the attachments
2020-02-27 22:58:43 +00:00
## v0.3.0
*Mar. 1, 2020*
2020-02-27 22:58:43 +00:00
- Support for many more document types has been added (including
images and office documents). All input files are converted into PDF
files (the original file is preserved).
- PDF Text extraction improved by omitting OCR if text can be
stripped.
- There is a new PDF viewer (utilizing viewerjs) that also works in
mobile browsers.
- Improve editing notes: Since notes may evolve, there is now a larger
edit form and a markdown preview.
- Show the extracted information (text, labels, proposals) of an
attachment in the Webui.
- The name search now also searches in item notes.
- Bug fixed where it was possible to create invalid input when
creating new sources.
- Bug fixed where the item menu was not properly initialized for
equipments.
- The `ds.sh` script has now an option to check a file for existence
in docspell.
### Configuration Changes
The configuration of the joex component has been changed.
- removed `docspell.joex.extraction.allowed-content-types`
- other settings in `docspell.joex.extraction` have been moved to
`docspell.joex.extraction.ocr`
- added `docspell.joex.extraction.ocr.max-image-size`
- added `docspell.joex.extraction.pdf.min-text-len`
- added sections in `docspell.joex.convert` for pdf conversion
settings
### REST Api Changes
The REST Api has some additions:
- new route to retrieve the original file
- new route to get the rendered pdf of an attachment (using viewerjs)
- add field in `ItemDetail` data that refers to the original files of
the attachments
## v0.2.0
*Jan. 12, 2020*
The second release of Docspell addresses some annoying issues in the
UI and adds a "send by email" feature.
- Send an item and its attachments via E-Mail (requires to setup SMTP
settings per user)
- Add a search field for meta data
- The item detail view is now a perma-link
- New endpoints to check whether a file is in Docspell by using their
SHA-256 checksum (see the api doc here and here), the scripts in
tools/ now use this endpoint to skip existing files
- Better support multiple attachments with long names in the UI
- Fixes textarea updating issues
## v0.1.0
*Sep. 21, 2019*
The initial release of Docspell containing the basic features with a
Web UI:
- Create items by uploading PDF files
- Analyze the PDF files and propose meta data
- Manage meta data and items
- View processing queue