Docspell changelog

Changelog History

Page 1

• v0.22.0 Changes

  Apr 11, 2021

  🚀 This release fixes some annoying bugs and prepares the web-ui to be translated into other languages. For actual translating them, I ask for your help. There is a detailed post about how to start with it in 🌐 the docs.

  • ♻️ Refactor webui to prepare for localisation (#726)
  • ➕ Add names to user defined tasks for better documentation (#712)
  • 🛠 Fixes some ui bugs:
    • scrollbar position (#722)
    • other minor ui related fixes (#746)
  • ✂ Removed deprecated api endpoints, fixing #482
  • 🛠 Fixes bug where items are already shown in the ui, although still in processing (#719)
  • Switch to github actions for ci (#748)
  • 🛠 Fixes a bug in the new query language (#754)
  • 🛠 Fix counters for categories in the search menu (#755)

  REST Api Changes

  • ✂ remove deprecated endpoints: sec/item/searchForm, sec/item/searchFormWithTags, sec/item/searchFormStats
  • ➕ adds category-count data to SearchSummary

  🔧 Configuration Changes

  • none

• v0.21.0 Changes

  Mar 13, 2021

  🚀 The main feature of this release gives a very flexible way of searching for documents, using a query.

  • ➕ Add a query language to provide a flexible way for searching
    • the search form now is translated into a search query
    • allows to search for items not in a folder or not in a specific folder (#628, #379)
    • Allows for range searches in custom fields (#540)
    • And more! See the documentation
  • ➕ Add a use attribute to all metadata, to be able to exclude them from suggestions (#659)
  • 👍 Allow to submit items for reprocessing via the UI (#365)
  • ➕ Add Latvian language (#679)
  • Scrollbars are back! (#681, #677)
  • 👷 The ds.sh script was changed to inform the processing jobs to also check for duplicates (#653)
  • 🐳 Docker setup now uses again a fixed hostname (#608)
  • ✅ Moving the unit tests to MUnit (#672)
  • ✂ Remove the old UI code (#636)
  • 🛠 Fix date extraction for English (#665)
  • 🛠 Fix bug when reading contacts from extracted text (#709)
  • 🛠 Fix bugs when reading mails (#691, #678)
  • 🛠 Fix a bug that wouldn't show an error message when entering bad characters in the register form (#663)
  • 🛠 Fixes a typo in the user settings menu (#654, thanks @ChristianKlass)

  📄 Thanks to everyone showing interest in docspell and dedicating time by ✅ opening issues, testing and providing ideas!

  REST Api Changes

  Note there are breaking changes in the REST Api

  • previous search and searchWithTags has been renamed to searchForm and searchFormWithTags, respectively
  • same with searchStats, it has been renamed to searchFormStats
  • The new search route can be used with GET and POST requests and accepts now a search query and also a flag for whether returning details or not (there are no separate endpoints anymore)
  • The new searchStats accepts a query
  • The ItemQuery data structure is now only a query string, without limit and offset
  • Organization and Person have an additional use attribute

  🔧 Configuration Changes

  🔧 There were no changes to the configuration files.

• v0.20.0 Changes

  Feb 19, 2021

  🚀 This release comes with a completely new ui based on tailwindcss, including a dark theme! ➕ Additionally there are some other minor features and bug fixes.

  • 🆕 New Web-UI with light and dark theme (#293).
    • All markup and css was reworked. For this release, the old ui is still available as a fallback if something got missing while porting. The old ui will be removed in the next release.
    • Experience on mobile devices is greatly improved
    • to get back to the old ui, you need to install a browser extension to be able to add a request header. Check this for firefox or this for chromium
    • then add the request header Docspell-Ui with value 1. Reloading the page gets you back the old ui.
  • 💻 With new Web-UI, certain features and fixes were realized, but not backported to the old ui:
    • foldable sections in search and multi-edit menu (#613, #527)
    • show current item in detail view (#369)
    • fixed some ui issues regarding processing logs (#363)
    • scrollbar fix (#600)
  • 👍 Allow a person to be correspondent, concerning or both (#605)
  • ➕ Add a short-name field to the organization (#560)
  • ➕ Add a description field to the equipment (#633)
  • 👍 Allow to specify a language for a source url (#651). This can be used to define upload urls per document language.
  • Trim whitespace for certain fields (#539)
  • 🐳 A different docker entrypoint for the consumedir script was added that supports polling (thanks @JaCoB1123, #603, #624)
  • 🛠 Fix duplicate suggestions (#627)
  • 🛠 Fix reading mails with empty headers (#606)
  • 🛠 Fix suggesting person that doesn't belong to the suggested organization (#625)
  • Cleanup registered nodes periodically (#618)

  REST Api Changes

  • The Person structure was changed: the concerning boolean flag is replaced by a use attribute
  • The Equipment structure has an additional notes attribute
  • The Source structure has an additional language attribute

  🔧 Configuration Changes

  • joex:
    • additional section in house-keeping to configure the periodic node cleanup task

• v0.19.0 Changes

  Jan 25, 2021

  🚀 This release comes with major improvements to the text analysis 🔧 module. It is now much more configurable, has improved results and can learn tags from all categories. Additionally, more languages for document processing have been added and it's now easier to add more. Please open an issue if want more languages to be included.

  • text analysis improvements (#263, #570)
    • docspell can now learn from all your tag categories
    • the detection for correspondents/concerned entities has been improved by using the classifier for this, too
    • all text analysis steps are now configurable that makes it possible to adapt it better to your data and machine.
    • The docs have been updated with some details here and here.
  • more languages (#488)
    • Adds: Spanish, Italian, Portuguese, Czech, Dutch, Danish, Finnish, Norwegian, Swedish, Russian, Romanian
    • languages have different support for text-analysis, but there is some basic support for all
    • there is extended support for English, German and French through Stanford CoreNLP nlp models (as before)
  • scan mailbox change (#576)
    • The change from last version (#551) has been moved behind a flag in the "scan mailbox settings". Please review your scan mailbox tasks in your user settings.
    • The scan mailbox settings form view has been organized into tabs, as it grew too large for a single form.
  • 📦 nix tools package fixed (#584)
    • If you are using docspell tools package for nix, it has now been fixed in that all scripts are available. They are now all prefixed by ds- (except the ds script)
  • 🛠 fix deleting organization (#578)
    • Due to the new relationship of a person to an organization, deleting an organization whith references a person was not possible. This is now fixed.
  • base url fix (#579)
    • The baseurl setting is optional, but when specified it was required to omit a trailing slash. This is now fixed in that it is always rendered without the trailing slash to the client, no matter what is in the config
  • 🏷 tag category case sensitive search fix (#568)
    • This was a bug introduced by the last release. When tag categories can now be spelled upper- or lower-case. In 0.18.0 you had to spell them lowercase, otherwise the search doesn't work.
  • ➕ adds a workaround for mails that don't specify their used charset (#591)

  💥 Breaking Changes

  • 🔧 The joex configuration changed around text analysis. If you had some custom settings there, please review these wrt the new default config.
  • 📦 When using the nix package manager: the tools package renamed the scripts to be better distinguishable, since they all end up in $PATH. They are now prefixed by ds-.
  • 🐳 The path of the consumedir script changed in the consumedir docker image
  • The settings of the scan-mailbox task has been extended by another flag. It controls when to apply the post-processing (moving or deleting). If you were relying that all mails (even those excluded by a subject filter) where moved away, you need to check your scan-mailbox task settings.

  REST Api Changes

  • the data structure for ClassifierSettings changed to allow specfiying a blacklist or whitelist of tag categories and the enabled flag has been removed.

  🔧 Configuration Changes

  • joex
    • the config regarding text analysis changed, there are new config options, like nlp.mode and the max-due-date-years has been moved inside text-anlysis. Please have a look at the new default config if you changed something there.
    • The regex-ner section has changed: the enabled flag has been removed, you can now limit the number of entries using max-entries to apply and 0 means to disable it.

• v0.18.0 Changes

  Jan 11, 2021

  • 🔋 Feature: Results summary and updated tag count (#496, #333)
    • A search summary can be displayed that shows the overall result count and to each custom field with a numeric type (number or money) small statistics like sum, average and max/min values. This is useful when you track your expenses on invoices or receipts.
    • This additional ui element can be enabled/disabled in your ui settings.
    • The result summary is now also used to update the tag counts in the search menu according to the current results.
  • 🔋 Feature: password reset (#376, docs)
    • Adds a new route for admins to reset the password of a user
    • Admin users are those with access to the config file, the endpoint requires to supply a secret from the config file.
    • A bash script is provided for more convenient access.
    • Note this also moves the re-create index endpoint behind the same secret! See below.
  • 🔋 Feature: custom fields clickable (#514)
    • The item detail view allows to click on tags to quickly find all tagged items. This now works for custom fields, too.
  • 🔋 Feature: scroll independently (#541)
    • The search menu can scroll now independent from the main area containing the item cards.
  • 👌 Improvement: improve attachment selection (#396)
    • When selecting an attachment, it shows its preview to the name instead of the name only
  • 👌 Improvement: wildcard search for custom date fields (#550)
    • Searching for custom field values allows to use a wildcard * at beginning or end. This is also enabled for date-fields.
  • 👌 Improvement: joex memory (#509)
    • Joex currently requires a lot of memory to hold the NLP models. After idling for some time, which can be configured and defaults to 15 min, the NLP model cache is cleared. This reduces memory load and makes it possible for the JVM to give it back to the OS.
    • This is supposed to relieve memory consumption when idling only. However, whether it is reclaimed by the OS depends on the JVM and its settings. To observe it early, use the G1GC garbage collector. This is enabled by default for JDK11. So it is recommended to use JDK11 (which is used in the docker images).
  • 👌 Improvement: allow scaling joex with docker-compose, thanks @bjeanes (#552)
    • This allows to easily start multiple joex containers via docker-compose
  • 👌 Improvement: allow to connect with gmail via app specific passwords (#520)
    • Imap settings have been extended to be able to specify if a OAuth2 should be used or not.
    • Before, OAuth2 was the default when the server has advertised it. This has been changed now, which means you need to adapt your IMAP settings if you currently use OAuth2
  • 🛠 Fix: provide multiple possible date suggestions for English documents (#561)
  • 🛠 Fix: add missing language files to joex docker image (#525)
  • 🛠 Fix: fix a bug that occurs when processing is restarted (i.e. after a crash) (#530)
  • 🛠 Fix: fix a bug in the ui where the mail connection field was not correctly updated (#524)
  • 🛠 Fix: fix bug when importing mails with an applied filter (#551)

  💥 Breaking Changes

  • Rest Server config:
    • If you specify the fulltext-search.recreate-key, you need to change your config. Delete it and use the secret now for the new setting admin-endpoint.secret.
  • routes
    • The route to drop and recreate the fulltext search index has been moved. It is now at /admin/fts/reIndexAll. The secret must now provided as http header and not in the url.
  • collective settings:
    • The imap settings have a new flag which indicates whether OAuth2 auth mechanism should be prefered. This is false by default. If you have used it with OAuth2 (like with gmail) you need either set this flag to true manually or use an application specific password.

  REST Api Changes

  • Rest Server:
    • Move endpoint /open/fts/reIndexAll/{id} to /admin/fts/reIndexAll. The secret must now be specified via an http header Docspell-Admin-Secret.
    • Add /admin/user/resetPassword which requires a http header Docspell-Admin-Secret with a value from the config file.
    • Add /sec/item/searchStats to return a search result summary
    • Changes ImapSettings to include a useOAuth flag
    • Remove fileCount from the TagCloud structure
    • The return value for /sec/item/searchStats now contains all tags, before tags with count == 0 were excluded

  🔧 Configuration Changes

  • Rest Server:
    • adds admin-endpoint.secret (without any value) that is the secret for the new "admin endpoint"
    • Removes full-text-search.recreate-key, the route that was using this key is now moved in the admin endpoint and therefore shares this secret now.
  • Joex:
    • adds clear-stanford-nlp-interval = "15 minutes" which is the joex idle time to clear the nlp cache
    • The default pool-size is set to 1. You can increase it on stronger machines.

• v0.17.1 Changes

  Dec 15, 2020

  🚀 An unfortunate bug has made it into the previous release that makes 🚀 the webapp near unusable. Therefore this release, containing only the 🛠 fix for #508.

  Sorry for the inconvenience!

• v0.17.0 Changes

  Dec 14, 2020

  🚀 This release comes with some smaller features:

  • 🔋 Feature: Remember-Me – another cookie is used to provide a remember-me functionality. The cookie is checked against some value in the database, so an admin can always make all remember-me cookies invalid. (#435)
  • 🔋 Feature: Link persons to organizations. In the address book, a person can now be associated to an organzition. The dropdowns show a little hint for which organization a person belongs to. Also suggestions for persons are restricted to those of the organization if that has been associated before. (#375)
  • 🔋 Feature: Allow to filter on source names. The search form can now search by a source name. The new field can be hidden via ui settings (it must be activated for exising users). (#390)
  • 🔋 Feature: Customize the title and subtitle of the item card in the overview. You can now define patterns for the title and subtitle of a card. (#429)
  • 🔋 Feature: Export your data. A bash script has been added that goes through your items and downloads them all to disk (including their metadata!). This can be used to periodically backup the data in docspell.
  • 👌 Improvement: The webui has been improved in that the search bar and search form are unified regarding the text search. The two fields in the form, allowing to search in names and fulltext, have been combined into a single field just as the search bar. (#497)

  🚀 This is the last release for 2020. I had hoped to put more into this, but this time of the year is always a busy one ;-). I want to thank 👍 you for your support and interest in this project and I wish you all a joyful Christmas time!

  REST Api Changes

  • The Person structure now takes a reference to the organization.
  • ItemSearch is extended with the source field.
  • UserPass is extended to include a rememberMe flag

  🔧 Configuration Changes

  • Restserver:
    • a remember-me section was added to the auth section
  • Joex:
    • a cleanup-remember-me section was added to the house-keeping tasks.

• v0.16.0 Changes

  November 28, 2020

  📚 Changelog • Documentation

  🚀 This release brings the "custom metadata fields" feature. It allows you to define custom fields and associate values to your items. Additionally there are some ui and other fixes and improvements.

  🍱 ℹ️ Existing users must enable "Custom Fields" in their users settings in order to use this feature.

  • 🔋 Feature: Custom Fields – define custom metadata fields an set values for them on your items. For example, this can be used to track invoice numbers, pagination stamps etc. Fields can be defined per collective and carry a format (or type). (#41)
  • 🔋 Feature: The language has been added to the metadata of an upload request and therefore overrides the collective's default language. This means you can now set the document language with each document. (#350)
  • 🔋 Feature: Show the currently logged in user and the collective in the web app. (#329)
  • 🔋 Feature: Tag categories are presented as a dropdown, where you can choose an existing one or type a new one. (#331)
  • Feature: The dropdown fields for a person have been changed in that the options are now restricted to the corresponding scope: the correspondent person only shows persons not marked as concerning and vice-versa. (#332)
  • 🔋 Feature: Add CC and BCC recipients to item mail (#481)
  • The consumedir.sh scripts was improved:
    • log a warning for all subfolders that currently wouldn't work due to configuration problems (#386)
    • ignore hidden files on linux (starting with a dot .)
    • include the parameter skipDuplicates into the upload request when the -m option is present
  • 🛠 Fixes a bug that prevented detecting dates in january (#480, thanks @vanto!)
  • 🛠 Fixes updating search view after changes like deleting item in multi-edit mode or updating tags via drag-and-drop.

  📄 The list of issues is here.

  📄 There were changes to the http endpoints; please checkout the Changelog for details.

• v0.15.0 Changes

  November 15, 2020

  📚 Changelog • Documentation

  🛠 This release adds the "preview feature", where a thumbnail of the first page of each attachment can be shown in the overview. Additional there are some bugfixes and UI improvements.

  👀 ℹ️ Docspell will start creating preview images for all your files when starting. If you don't see all of them immediatly, wait some time until they have been all created. It starts with newest files, so you should see some images shortly.

  🍱 ℹ️ Existing users must (if wanted) enable the preview feature in the user ui settings.

  • 🔋 Feature: create a thumbnail of every file. The scale factor can be configured in the config file. The user can choose in the ui, what size to display and whether to display it or not. (#327)
  • 🔋 Feature: Display the number of pages in the overview (#325)
  • 🔋 Feature: Extend the upload request to allow to specify a file filter and a list of tags (#346, #385):
    • file filter: this is a glob that selects files when an archive file (a zip or e-mail file) is uploaded
    • tag list: allows to specify a list of tags that are automatically set on the item that is being created
    • these two settings are added to the scan-mailbox form and the source-form
  • 🔋 Feature: Filter mails to import by subject (#384)
  • 🔋 Feature: Add quick links to item-detail and overview to jump to a specific search view; e.g. click on correspondent takes you to the overview with this correspondent selected in the search menu (#355)
  • 👌 Improved css assets (#349)
    • Moved from Semantic-UI to Fomantic-UI, which is an actively maintained fork of the former
    • Removed the request to obtain a google font. Now you can use docspell without hassle in environments without internet connection
    • jquery could be dropped as a js dependency
  • 👌 Improved ui for multi select mode when selecting items
  • 🛠 Fix a bug when creating new scan-mailbox settings (#382)
  • 🛠 Fix a build issue that resulted in missing scripts in the tools zip file.
  • 🛠 Fix a bug that added the .pdf extension twice. The filename can now be defined in the config file. (#397)

  📄 There were changes to the http endpoints and additional config values; please checkout the Changelog for details.

• v0.14.0 Changes

  November 01, 2020

  Nov 1st, 2020

  🚀 This release contains many bug fixes, thank you all so much for helping out! There is also a new feature and some more scripts in tools.

  • Edit/delete multiple items at once (#253, #412)
  • 💻 Show/hide side menus via ui settings (#351)
  • ➕ Adds two more scripts to the tools/ section (thanks to @totti4ever):
    • one script to import data from paperless (#358, #359), and
    • a script to check clean a directory from files that are already in docspell (#403)
  • 🐳 Extend docker image to use newest ocrmypdf version (#393, thanks @totti4ever)
  • 🛠 Fix bug that would stop processing when pdf conversion fails (#392, #387)
  • 🛠 Fix bug to have a separate, configurable source identifier for the integration upload endpoint (#389)
  • 🛠 Fixes ui bug to not highlight the last viewed item when searching again. (#373)
  • 🛠 Fixes bug when saving multiple changes to the ui settings (#368)
  • 🛠 Fixes uniqueness check for equipments (#370)
  • 🛠 Fixes a bug when doing document classification where user input was not correctly escaped for regexes (#356)
  • 🛠 Fixes debian packages to have both (joex + restserver) the same user to make H2 work (#336)
  • 🛠 Fixes a bug when searching with multiple tags using MariaDB (#404)

  REST Api Changes

  • Routes for managing multiple items:
    • /sec/items/deleteAll
    • /sec/items/tags
    • /sec/items/tagsremove
    • /sec/items/name
    • /sec/items/folder
    • /sec/items/direction
    • /sec/items/date
    • /sec/items/duedate
    • /sec/items/corrOrg
    • /sec/items/corrPerson
    • /sec/items/concPerson
    • /sec/items/concEquipment
    • /sec/items/confirm
    • /sec/items/unconfirm
    • /sec/items/reprocess
  • ➕ Adds another parameter to ItemSearch structure to enable searching in a subset of items giving their ids.

  🔧 Configuration Changes

  • 🆕 new setting ….integration-endpoint.source-name to define the source name for files uploaded through this endpoint

• 1
• 2
• 3
• Next ›
• Last »