Docspell v0.24.0 Release Notes

  • Jun 18, 2021

    ๐ŸŒ This time a translation of the Web-UI in German is included and the ๐Ÿš€ docker build was overhauled. The releases are now build and tested using Java 11.

    • ๐Ÿณ Rework Docker setup. Images are now provided for different architectures and have a new home now (see below). The images are now built via a github-action from the official packages of each release. (#635, #643, #840, #687)
    • ๐ŸŒ Translation of the UI into German (thanks to @monnypython for proof reading and applying lots of corrections!) (#292, #683, #870)
    • ๐Ÿ‘Œ Improve migration of SOLR (#604)
      • The information whether solr has been setup, is now stored inside SOLR. This means when upgrading Docspell, all data will be re-indexed.
    • โž• Add --exclude and --include options to the consumedir.sh script (#885)
    • ๐Ÿ‘Œ Improved documenation of the http api (#874)
    • โœ‚ Removed unused libraries in the final packages to reduce file size a bit (#841)
    • ๐Ÿ› Bug: Searching by tag category was broken when using upper case letters (#849)
    • ๐Ÿ› Bug: when adding a boolean custom field, it must be applied immediatly (#842)
    • ๐Ÿ› Bug: when entering a space in a dropdown the menu closes (#863)
    • ๐Ÿ› Bug: Some scripts didn't work with earlier versions of jq (#851)
    • ๐Ÿ› Bug: The source form was broken in that it didn't load the language correctly (#877)
    • ๐Ÿ› Bug: Tag category options were wrongly populated when narrowing tags via a search (#880)

    ๐Ÿ’ฅ Breaking Changes

    Java 11

    ๐Ÿ— Not really a breaking change. Docspell is now build and tested using ๐Ÿ“„ Java 11. Docspell has a small amount of Java source code. This is compiled using Java 11 but to target Java 8 JVMs. So it still can run under Java 8. However, it is recommended to use at least Java 11 to ๐Ÿ“„ run Docspell.

    ๐Ÿณ Docker Images

    ๐Ÿณ The docker images are now pushed to the ๐Ÿณ docspell organization at ๐Ÿณ docker-hub! So the images are now:

    • ๐Ÿ“„ docspell/restserver
    • ๐Ÿ“„ docspell/joex
    • ๐Ÿ“„ docspell/tools

    ๐Ÿท Tags: images are tagged with two floating tags: nightly and โœ… latest. The nightly tag always points to the latest development โœ… state (the master branch). The latest tag points to the latest ๐Ÿš€ release. Each release is also tagged with its version number, like v0.24.0.

    The images changed slightly in that there is no assumption on where ๐Ÿ“„ the config file is placed. Now you need to pass the docspell config file explicitely when using the images.

    ๐Ÿ— Multiarch: Images are now build for amd64, arm64 and armv7.

    ๐Ÿ“„ The consumedir is being replaced by the more generic docspell/tools image which contains all the scripts from the tools/ section. That means it has no special entrypoint for the consumedir script anymore. The polling functionality is now provided by the consumedir script. ๐Ÿณ And the docker-compose file needs now to specify the complete command arguments. This makes it much more flexible to use.

    This allows to use this image to run all the other tool scripts, too. ๐Ÿ›  The scripts are in PATH inside the image and prefixed by ds-, so for example ds-consumedir or ds-export-files etc.

    ๐Ÿณ Docker Compose

    ๐Ÿณ The docker-compose setup is now at docker/docker-compose. Please look at the new compose ๐Ÿณ file and do the corresponding changes at yours. Especially the consumedir container changed significantly. Then due to the fact that the config file must be given explicitely, you need to add this argument to each ๐Ÿ“„ docspell component (restserver and joex) via a command section (see the compose file referenced above).

    The .envrc has been cleaned from some settings. Since the config files is mounted into the image, you can just edit this file instead. The only settings left in the .envrc file are those that need to be ๐Ÿณ available in the docker-compose file and the application. If some settings need to be duplicated for joex and restserver, you can use the builtin variable resolution mechanism for this. An example is provided in the new config file.

    ๐Ÿ”ง Configuration Changes

    None.

    Rest API Changes

    None.