docspell

Commits

• a7bae53: Update commons-io to 2.14.0 (eikek-scala-steward) #2306

Commits

• 1ad79cb: Update cats-effect to 3.5.2 (eikek-scala-steward) #2305

Commits

• 3fb6c46: Update stanford-corenlp to 4.5.5 (eikek-scala-steward) #2303

Commits

• 1659cb6: Update flyway-core, flyway-mysql to 9.22.2 (eikek-scala-steward) #2300

Commits

• 99345e4: Update alpine Docker tag to v20230901 (renovate[bot]) #2250

Commits

• 44e68e6: Update tika-core to 2.9.0 (eikek-scala-steward) #2236

Commits

• cacf5ca: Update mariadb-java-client to 3.2.0 (eikek-scala-steward) #2234

Commits

• f957797: Update sbt to 1.9.4 (eikek-scala-steward) #2232

Commits

• 86c49b8: Update swagger-ui to 5.4.2 (eikek-scala-steward) #2228

Commits

• 5bfd4d1: Update dependency postcss to v8.4.28 (renovate[bot]) #2225

Commits

• 51f4ace: Update swagger-ui to 5.3.1 (eikek-scala-steward) #2220

Commits

• 821c525: Update scribe, scribe-slf4j2 to 3.11.9 (eikek-scala-steward) #2215

Commits

• d27c8ae: Update scalafmt-core to 3.7.11 (eikek-scala-steward) #2196

🎉 Changelog • Documentation • Milestone 🎉

This release contains some bug fixes and improvements.

• Add Ukrainian language (#1835, @GooRoo)
• webui: normalize , to . for numeric fields (#1975)
• improve error reporting when file backend fails (#1976)
• docker: remove exlpicit zlib install (#1863)
• nix: implement nix flake (#1869, @VTimofeenko)
• nix: replace wkhtmltopdf with weasyprint (#1873, #1895, @VTimofeenko)
• fix listing shares with no name (#1840)
• fix html conversion of text files (#1915)
• fix: remove test-scoped dependencies from artifacts (#1856)
• fix deletin users (#1941)
• fix notification for collective scoped tasks (#1987)

🎉 Changelog • Documentation • Milestone 🎉

This release contains some bug fixes, updates docker images and includes some internal change to get a bit forward with #585 (user groups).

• Allow to set extracted content (#1775) You can now fix OCRed text this way.
• Improve handling mixes of OIDC and local accounts (#1827). It is now possible to use the same account locally and via OIDC.
• Add Estonian language (#1646)
• Updated docker images to new alpine and openjdk, fixing #1736 (#1713) by @jberggg and @eikek
  • drops support for arm7 (#1719)
  • introduces weasyprint as an alternative to wkhtmltopdf for converting html files to pdf
• Fix docspell's query to remove attach.count. It has been removed a while ago, but the query language didn't reflect it (#1758)
• Fix search for linked items (#1808)
• Fix item selection after merging (#1809)
• Internal changes to how a collective is referenced as a preparation for #585 (#1686)
• Update H2 to 2.1.x, incompatible to the previous used version (#1690)

Warning

The database structure changed substantially in this release. Please make sure to create a backup of your database before attempting the upgrade!

Docker

There are two major changes for docker users: First ARM7 support has been dropped, because it was too much work to maintain alongside the other architectures. Second the images have been updated to the latest alpine linux, which requires to sacrifice using wkhtmltopdf as a tool to convert HTML to PDF (often used for processing emails).

The joex image doesn't have the wkhtmltopdf binary anymore, because it is not available for alpine linux. Instead weasyprint has been added. Docspell by default still uses wkhtmltopdf, because I found it has better results. But you can now switch to weasyprint and if you use the provided docker images you have to.

There is a new config that you need to set - when using environment variables:

DOCSPELL_JOEX_CONVERT_HTML__CONVERTER=weasyprint

Just add it to the env variables in the docker-compose.yml. If you use a config file, add this to it:

docspell.joex {
  convert.html-converter = "weasyprint"
}

File Backends

The internal change on how collectives are now referenced requires to adopt the files accordingly. If you have your files in the database, all is being migrated automatically on first start.

For other file backends, the files must be migrated manually. The difference is that from now on a collective is referenced by a unique number and not by its name anymore. You can look at the table collective to see which number was assigned to a collective and then

• for a filebackend, simply move the folder with a collective name to its corresponding number
• for s3 backend the same must happen, using some s3 client (maybe this one)

H2

If you use H2 as a database, there are some manual steps required. H2 was bumped from 1.4.x to 2.1.x and the new version cannot read the database files of the old version.

Additionally, one of the changesets for H2 used a now illegal syntax and had to be changed. This will lead to checksum mismatch errors when starting up.

Creating and restoring a dump, the script tools/h2-util.sh can be used. The H2 version can be specified with an environment variable H2_VERSION to easily create a dump in one version and restore in another.

To fix the changeset, you could simply run this sed command on the dump before restoring:

sed -i 's,175554607,-276220379,g' docspell-dump-h2.sql

But this could potentially change not only the checksum, but other things in the dump. It is not very likely, though. A more safe alternative is to use a text editor and find the correct place (in table flyway_schema_history) to change or just set database-schema.repair-schema = true in the config file or use the env variables

DOCSPELL_SERVER_BACKEND_DATABASE__SCHEMA_REPAIR__SCHEMA=true

and startup only the restserver one time to have the checksum fixed. Another safe variant is to run this update statement on your h2 database:

UPDATE flyway_schema_history set checksum = -276220379 WHERE version = '1.9.3';

🎉 Changelog • Documentation • Milestone 🎉

This release fixes some issues related to OpenID connect integration and addons.

• Allow to skip login page if a single OIDC provider is configured (#1640)
• Add config to force OCR on a PDF even if text would be available (#1628)
• Improvements for OIDC integration (#1619, #1545)
• Improve unzipping/zipping files (#1603)
• Fix starting a background task to install addon (#1601)
• Add more database indexes to improve search (#1584)
• Add paging to the share view (#1582)
• Remove unused code (#1581)

🎉 Changelog • Documentation • Milestone 🎉

This is more a bug fix release, targeting mainly fixes related to addons.

• Fix e-mail address input field (#1565)
• Overhaul of search when fulltext search is applied. Fixes #1363.
• Return when a search exceeds server configured limit for page size (#1358)
• Several fixes related to addons (#1566, #1573)

🎉 Changelog • Documentation • Milestone 🎉

This release allows to extend Docspell with custom scripts/programs. This is still an experimental feature, I expect more changes coming. But you are invited to give it a try 😄!

• Extend docspell via addons (experimental feature) (#1550) There are two addons to play with
  • rotate-pdf-addon for rotating pdf files
  • audio-files-addon can provide basic support for audio files
• Adds Lithuanian and Polish to document languages (#1540, #1345)
• Quick guide for adding more languages (#942)
• Make dashboard boxes headlines bold (#1531)
• Improve logging config; allow to specify loggers and their level (#1535)
• Allow for auth tokens to optionally be issued with an validity (#1533, #1534)

Note to docker users: The docker image of the previous release contained a "broken" zlib library that affected checksum generation for the db migrations (see #1517). The image of this release has an updated version of this system library. This means that it is quite likely that those who were not affected by this in 0.35.0 (for example, you started with a fresh db) - could now be affected. If you get these errors, try to "repair" the migrations. Apply the following settings in the docker-compose file for one start:

DOCSPELL_SERVER_BACKEND_DATABASE__SCHEMA_REPAIR__SCHEMA=true
DOCSPELL_SERVER_BACKEND_DATABASE__SCHEMA_RUN__FIXUP__MIGRATIONS=true
DOCSPELL_SERVER_BACKEND_DATABASE__SCHEMA_RUN__MAIN__MIGRATIONS=true

Start up one time and stop again. Then remove these settings again.

🎉 Changelog • Documentation • Milestone 🎉

• Download multiple documents as zip (#1093). The webui allows to download multiple files as a zip archive. The zip file is created at the server and cached for a while.
• New project ds4e providing utilises to access Docspell from Emacs
• Increase size for password fields in the database (#1508)
• Hide the delete button in new notifciation channel forms (#1506)
• Fix logging (#1468), non-errors were logged as errors.
• Apply the migration fix from last version only from 0.32.0 onwards (#1469)
• Fix typos in UI (#1510, @monnypython)
• Add support for Postgres FTS in nix module (#1512, @LeSuisse)