Skip to content

v0.6.0
Compare
Choose a tag to compare
@DavidMStraub DavidMStraub released this 06 Apr 18:09
· 147 commits to master since this release
v0.6.0
7b97e9e

This is the first in several releases which introduce some API changes that are foreseen to enable support for hosting multiple family tree databases ("trees") on a single Gramps Web API deployment. Most (but not all) of these changes will be backwards compatible and the existing possibility of hosting a single tree will not be removed.

API changes

  • The DISABLE_AUTH config option has been removed. It is no longer possible to run the API without authentication. See the docs for how to still easily query the API in local testing.
  • The search index is moved to a subdirectory of where it used to be. This means that after upgrading, the search index must be fully rebuilt. This can be done by running python3 -m gramps_webapi --config path/to/config search index-full on the command line or simply using the new "update search index" button in Gramps Web.
  • The thumbnail cache keys have changed. This only means the existing cached thumbnails will be ignored and it might make sense to clear the cache before the upgrade.
  • The format of the tokens is changed which might force users to logout if they are active during the upgrade (but it should not invalidate the refresh tokens).
  • Setting config options via environment vairables without the GRAMPSWEB_ prefix is deprecated and will be removed in a future release. Note that the unprefixed variables are already ignored if a corresponding prefixed one is present and the default docker file defines some of them. Those can only be overridden with prefixed ones.

Note that this release changes the schema of the user database. When using the default docker image, the migration will be performed automatically. Otherwise, use the (new) command python3 -m gramps_webapi --config path/to/config user migrate

New features

  • Database exports now profit from the new task queue, if configured. Instead of generating and downloading the export in a single request with GET, a new POST endpoint triggers the export in the background and, once complete, can be fetched from a separate endpoint. See the API spec for details.
  • The search endpoint now supports searching for non-ASCII strings by querying for a transliterated string. For instance, the query string Beograd will also yield results that only contain Београд.

Security issue

Users running the development version off the master branch (or the latest-devel docker image) may be affected by a security issue that was introduced in commit 0f99a9f 9 days ago and fixed in 338837a today. It caused the value of environment variables, such as SECRET_KEY, to be logged as clear text on the server. Users who think they might be affected by this issue are advised to change their secret key.

Assets 2
Loading