v0.7.0

This release contains breaking changes. Please read to the end of the release notes for upgrade instructions.

Multi-tree support

The main new feature in this release is initial support for hosting multiple family trees. As of this version, a Gramps Web API instance can serve multiple family tree databases, but each user account is linked to a single tree.

The default setup is still to serve a single family tree and the multi-tree setup is only recommended for advanced users. See the Gramps Web documentation site for instructions.

The following improvements are related to this new feature:

Add admin role

In addition to the "owner" role (that has full control of a family tree), there is now an additional role "admin" that has full control over all trees. This change affects also the single-tree setup: only "admin" users can view or edit the /api/config endpoints.

Add tree endpoints

The new /api/tree endpoints allow listing existing family trees as well as creating new ones.

Add people and media quotas

In order to manage a multi-tree, multi-user server, the possibility of imposing quotas on the total size of media files or the total number of people per tree has been added. When the quotas are reached, no media files or people can be added anymore.

Add shared PostgreSQL support

Support has been added for the SharedPostgreSQL Gramps addon, that allows storing multiple Gramps family tree databases in a single PostgreSQL database in an isolated way, which is particularly suited for a multi-tree Gramps Web API setup.

Other improvements

Use task queue for reports

If configured, the task queue is now also used for generating reports, which will prevent long running reports from causing a timeout.

Localize reports

The report endpoints gain a new locale parameter, which allows generating localized reports.

Bug fixes

• A bug affecting the synchronization of media files hosted on S3 with the Gramps Web Sync addon has been fixed
• Support for SMTP servers requiring authentication via STARTTLS has been added

Upgrade instructions

This release contains a change of the user database schema. If you use the default Docker image, the migration is done automatically. If not, please run python3 -m gramps_webapi --config path/to/config user migrate to migrate, replacing path/to/config with the path to your configuration file.