Docspell Documentation



Oct 19, 2020

This release contains bugfixes.

  • Improvements to the docker setup: application can be build from any version. Thanks to @totti4ever.
    • This change required breaking changes in the docker-compose.yml file. Please update your docker-compose.yml to the new version.
    • The image tags changed:
      • the -latest is now upper case, -LATEST
      • tagged releases include the version prefixed with a v, like in -v0.13.0
      • there are new -SNAPSHOT images that are build from the current master branch. Please note that snapshot versions may not be compatible with each other!
  • The date extraction tried to create invalid dates (#298)
  • Fixed order of job log entries that was undefined if entries were written very fast
  • Fix content column for MariaDB (#297)
  • Fixe regarding retrying processing of files: attached files were not correctly found and the duplicate check must not run
  • When "home-page" is rendered, do an initial search. This updates the view correctly if something changed when coming from item details.
  • Reset upload page on init (#294)
  • Fixes regarding base-url setting and auth cookie (#308)
  • Fixes in openapi spec (#338, #343)
  • Fixed error messages for modal dialogs (tag/organization/person) (#341)

REST Api ChangesπŸ”—

  • No changes, besides some fixes to urls in the spec to be constistent to the app.

Configuration ChangesπŸ”—

  • No changes.


Sep 28, 2020

Thanks to a lot of great input from users, this release fixes annoyances in the ui.

  • Improve startup experience wrt the base-url setting. Docspell now uses request headers to determine absolute urls if this setting is unchanged. (#250)
  • Fixes scrolling issues when going from detail to list view and vice versa. (#254)
  • Fix quick search component to keep search term between changes. (#261)
  • Docspell now provides a valid manifest to be an installable "pwa".
  • Fixes script to work with whitespace in filenames. (#269)
  • Fix hidden fields feature. Hidden fields are now resetted when clicking Confirm. (#256)
  • Improve Save Name in item detail: The save button is removed and changes are saved while typing. (#255)
  • Add keyboard shortcuts in item detail for navigating and confirm/unconfirm. (#225)
  • Detect duplicate files server side. The processing task is now able to detect duplicate files to skip them if desired. The ui has a new checkbox when uploading. (#252)
  • Improve view of many attachments to an item: The tab menu is replaced by a dropdown menu that allows to change attachments also on small screens and/or when there are many attachments.

Configuration ChangesπŸ”—

  • No changes to default config values.

REST Api ChangesπŸ”—

  • Amend ItemUploadMeta with a skipDuplicates flag for ignoring duplicate files on processing.


Sep 09, 2020

This is a bugfix release. The full-text-index requires a schema upgrade for the added language that got lost in the previous release.


Sep 07, 2020

This release didn't change much on the surface, but contains a lot of improvements for processing files.

  • Improves the recognition of correspondents and people in the documents. Until now, the analyser didn't know about the existing organizations/people of a collective. Now this data is given to the analyser as input which results in a higher accuracy when finding matches. This may result in high memory usage depending on the size of the collective data and therefore can be disabled in the config file.
  • Adds text classification. Docspell can now learn from your existing tagged items. Given a tag category, a statistical model is created from your existing documents and used to predict a tag (of that category) for new documents. Creating this model may need a lot of memory and therefore text classification can be disabled globally via the config file. Additionally each collective can enable/disable it. Learning is done periodically via a user-task that can be configured in the collective settings.
  • Adds the language french, supported for text extraction and text analysis.
  • Fixes some build failures that produced artifcats with source files.
  • Change the job priority of any waiting job from the Processing page.
  • Serving static asset files gzipped, to reduce bandwidth

Configuration ChangesπŸ”—

  • New settings in joex.analysis.regex-ner, ….classification and ….working-dir for the classifier and NER feature.
  • New setting in to hide/show the classifier settings on the Collective Settings page. If classification is disabled globally (i.e. from all joex instances), the feature can be hidden from the users.

REST Api ChangesπŸ”—

  • /sec/collective/classifier/startonce to start the learning task separately from the schedule.
  • /sec/queue/{id}/priority for setting a new priority of a job (only for jobs in waiting state)
  • The CollectiveSettings object is amended with a new ClassifierSetting object.


Aug 15, 2020

  • Lots of web ui improvements:
    • Rework the search menu for tags and folders: The dropdown field is removed for tags and folders. They are represented as a list and items can be cycled through to be included/excluded or deselected. It is possible to use drag-and-drop to associate tags to items and put items into folders.
    • Rework page that displays sources; allow to copy the urls and add a qr code
    • Add item notes to the cards in the list view, can be configured if it is shown or not (#186, #201)
    • Improve how the item notes are displayed in the item detail view (#186, #192)
    • Fix the Load more… button
    • Allow to search by tag categories (#203)
    • Allow to edit metadata in item detail view. Until now it was only possible to add new metadata (#205)
    • Do not cover the whole screen with the metadata modal dialog, only the menu is now covered so that it is possible to select text from the document (#205)
    • Allow to hide some fields from the menus. What fields to display can be configured in the ui settings (#195)
  • Implemented some routes that were specified in the openapi, but have not been implemented so far
  • Fix source upload routes where it didn't check whether a source is enabled or not. Further checks are now done as first step to not upload the file into memory for nothing if something fails (e.g. the source doesn't exist)
  • Re-process files. A route has been added that submits files for re-processing. It is possible to re-process some files of an item or all. There is no UI for this for now. You'd need to run curl or something manually to trigger it. It will replace all extracted metadata of the files,but doesn't touch the metadata of the item. (#206)
  • Add a task to convert all pdfs using the OCRMyPdf tool that can be used in docspell since the last release. This task converts all your existing PDFs into a PDF/A type pdf including the OCR-ed text layer. There is no UI to trigger this task, but a script is provided to help with it. (#206)
  • There is now an Android Client App to conveniently upload files from your android devices

Configuration ChangesπŸ”—

  • New setting docspell.server.max-note-length to specify how much of the item notes should be transeferred with each search result.

REST Api ChangesπŸ”—

  • Added /sec/collective/tagcloud to return all used tags of a collective. This is the same as returned from the insights route, but without all the other data.
  • Added /sec/item/convertallpdfs to trigger a task for converting all currently unconverted pdfs
  • Added /sec/item/{id}/taglink for associating tags given by name or id
  • Added /sec/item/{id}/tagtoggle for toggling tags given by name or id
  • Added /sec/item/{id}/reprocess for submitting an item for being re-processed


Aug 1st, 2020

  • New feature: folders. Users can create folders and put items into them. Folders can have members (users of the collective) and search results are restricted to items that are in no folder or in a folder where current user is a member. (see #21)
  • Folders can be given to the upload request.
  • Add ocrmypdf utility to convert pdf->pdf with ocr-ed text layer.
  • Extract PDF metadata and use the keywords to search for tags and apply them to the item during processing. (See #175)
  • Fix duplicate results when doing fulltext only searches
  • Several small bug fixes and improvements in the UI
    • Fix position of datepicker (see #186)
    • Fix race condition when updating calendar-event field
    • Sort tags by count in collective-insights view
    • Simplify search bar
  • New website

Configuration ChangesπŸ”—

  • Joex: add a section docspell.joex.convert.ocrmypdf for configuring the ocrmypdf tool.
  • Joex: change default value of ….extraction.pdf.min-text-len from 10 to 500.

REST Api ChangesπŸ”—

  • Add /sec/folder/* routes for managing folders.
  • Add /sec/item/{id}/folder for updating an item folder.
  • Change ItemSearch structure to be able to search for items in a specific folder.
  • Change ItemDetail and ItemLight structure, adding the item folder
  • Change ItemUploadMeta structure, adding a folder id field.
  • Change Source structure, adding a folder id field.
  • Change User structure, adding the user id


June 29, 2020

  • Adds the full-text search feature (see #69). It requires a separate Solr instance. Items can be searched by documents contents and item/file names. It is possible to use full-text search to further confine the results via the search menu.
  • Fixes column types for item date and due-date for MariaDB (see #158) and adds an upper limit for due-dates (which is configurable).
  • Fixes a bug when cancelling jobs. Stuck jobs were only removed from the queue, but their cancel routine was not called.
  • Changes in cancelling process-item jobs: the item will still be created and not removed.
  • Fixes a bug where items could not be deleted if there were sent mails attached.
  • Fixes the openapi spec for the joex component. This made the generated live documentation unusable.
  • Changes to the script:
    • Allow to recursively watch or traverse directories
    • Allow it to work with the integration endpoint. This allows using for all collectives.
  • The docker setup now starts a solr container automatically and configures the consumedir container to use the integration endpoint. It is still necessary to define an environment variable.

Configuration ChangesπŸ”—

  • Set new default for docspell.server.max-item-page-size to 200.
  • New full-text-search section for restserver and joex.

REST Api ChangesπŸ”—

  • Add /open/fts/reIndexAll/{key} to re-index the full-text search index. The key must be defined in the config file, so only admins can execute this.
  • Add /sec/fts/reIndex to allow a collective to re-index their data only.
  • Add /open/integration/checkfile/{id}/{checksum} to check whether a file is in docspell via the integration endpoint.
  • Add /sec/item/searchIndex to allow searching the full-text index only. This route returns the results as ordered by SOLR and not ordered by date.
  • The ItemSearch input data is extended to support the new full-text search field.
  • The ItemLight result structure now can contain "highlighting" information that is provided by the full-text search index.


June 17, 2020

  • Document integration endpoint and add a GET route to check it.
  • Add webui settings for the user. These settings only apply to the web client and are stored in the browser's local storage.
  • Enable paging in the item list view. The page size can be set in the new client settings. If the number of results is equal to this size, a button at the end of the page allows to load more.
  • The item list now contains all tags of an item.
  • The tag colors can be customized in the client settings. A color per tag category can be defined.
  • New meta data (tags, correspondents, concerned entities) can be created directly in the item detail view (see #138). No need to navigate away to the Manage Data page.
  • Fixes a bug in the dropdown widgets that would present items that have already been selected.
  • Allow to have multiple notify-due-items tasks.
  • New simple search feature: The list view now appears without the search menu by default. A search bar is shown instead that allows to search in item name and notes and in names of correspondents and concerned entities. The search menu can be opened as before. The name search field now only searches in item names (as before 0.3.0), i.e. it doesn't search item notes anymore, which is now possible with the allNames search field.
  • Fixes a bug where a search term was not lower-cased but compared to a lower-cased value (see #147).
  • Allow to change names of attachments.
  • Document how to create a SMTP gateway to docspell and provide a simple docker based setup. This is a SMTP server that delivers mails to docspell instead of using a mbox or maildir. It utilises the integration endpoint.

Configuration ChangesπŸ”—

  • Add docspell.server.max-item-page-size for a hard limit of the page size when fetching items.
  • Changed default value of docspell.server.integration-endpoint.allowed-ips.enabled to false.
  • Add docspell.server.backend.mail-debug to allow debug mail related problems.

REST Api ChangesπŸ”—

  • Add GET /open/integration/item/{id} to allow checking the integration endpoint.
  • Change all routes to update item properties (name, tags, direction, corrOrg, corrPerson, concPerson, concEquipment, notes, date, duedate) from POST to PUT.
  • Add corresponding POST routes to create and update meta data in one call. This is only applicable: corrOrg, corrPerson, tags, concPerson, concEquipment.
  • Add POST /sec/attachment/{id}/name to change the name of an attachment.
  • Change /sec/usertask/notifydueitems to return a list of notification settings.
  • Change the POST route to /sec/usertask/notifydueitems to only create new notification tasks.
  • Add a PUT route to /sec/usertask/notifydueitems to update existing notification tasks.
  • Add a GET and DELETE route to /sec/usertask/notifydueitems/{id} to retrieve or delete a specific notification task.
  • The ItemSearch structure is extended to allow specifying offset and limit for paging (which is required now). It also has an optional property allNames to provide the search term for the new simple search feature.
  • The ItemLight structure has now a list of tags.


May 25th, 2020

  • New feature "Scan Mailboxes". Docspell can now read mailboxes periodically to import your mails.
  • New feature "Integration Endpoint". Allows an admin to upload files to any collective using a separate endpoint.
  • New feature: add files to existing items.
  • New feature: reorder attachments via drag and drop.
  • The document list on the front-page has been rewritten. The table is removed and documents are now presented in a β€œcard view”.
  • Amend the mail-to-pdf conversion to include the e-mail date.
  • When processing e-mails, set the item date automatically from the received-date in the mail.
  • Fixes regarding character encodings when reading e-mails.
  • 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.
  • Fix webapp for mobile devices.
  • 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.
  • Fix redirecting / only to /app.

Configuration ChangesπŸ”—

The joex and rest-server component have new config sections:

  • 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.
  • Add docspell.server.integration-endpoint with sub-sections to configure an endpoint for uploading files for admin users.

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
  • The data used in /sec/collective/settings was extended with a boolean value to enable/disable the "integration endpoint" for a collective.
  • Add /sec/item/{itemId}/attachment/movebefore to move an attachment before another.


May 1st, 2020

  • Allow to delete attachments of an item.
  • Allow to be notified via e-mail for items with a due date. This uses the periodic-task framework introduced in the last release.
  • 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:
    • 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

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.


Mar. 29, 2020

  • 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%.
  • 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.
  • Bug fixes related to handling text files.
  • Add a configurable length limit for text analysis

Configuration ChangesπŸ”—

The configuration of the joex component has been changed.

  • new section docspell.joex.periodic-scheduler for configuring the periodic scheduler
  • new section for configuring house-keeping tasks
  • new section docspell.joex.text-analysis for configuring the new size limit
  • The command for running wkhtmltopdf changed in that the encoding is now added at runtime.

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


Mar. 1, 2020

  • 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 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


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


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