Addon:Gramps Web Sync

This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager. Please use carefully on data that is backed up, and help make it better by reporting any issues to the bug tracker. Unless otherwise stated on this page, you can download this addon by following these instructions. Please note that some Addons have prerequisites that need to be installed before they can be used.

Not for all versions of Gramps Released for Gramps 5.1.x / 5.2.x and 6.0.x. This documentation is derived from the Synchronize with Gramps section of the Gramps Web User Guide. Their page should be considered the definitive reference.

"Introduction" tab of "Gramps Web Sync" tool

The Gramps Web Sync tool is an addon for Gramps that allows you to synchronize a Gramps (for desktops) database with Family Tree data on a Gramps Web (for Servers), database including media files.

Purpose of this tool

This tool was specifically written to harmonize the family tree data between a "Gramps Web" instance and a "Gramps for Desktops" instance. Gramps Web is much younger than the desktop version, so not all the interface for the desired features have been created.

Make no mistake, maintaining synchronization is hard ! And this tool is not magic, it does not make the process simple but it is easier than the alternatives.

Gramps Web installation and account setup

Before you can start to use the Gramps Web Sync tool addon it requires a working Gramps Web installation has been setup and also requires a Gramps Web account with owner privileges.

The Gramps Web Sync tool addon can be installed like any other addon; see Installing Addons in Gramps.

There are no installation (or user interface options) on the Gramps Web side because the Gramps Web Sync tool communicates directly with that the Gramps Web webservice's native restful API.

Usage

You access the tool by using the menu Tools -> Family Tree Processing -> Gramps Web Sync....

Running Gramps Web Sync

Batch Tool warning

The tool will start with an Undo history warning dialog that suggest you Stop and backup your work, then select Proceed with the tool.

Introduction tab

"Introduction" tab of "Gramps Web Sync" tool

You are then presented with the Synchronization Assistants dialogs first Introduction tab that details the processes stages of Synchronization, select Next to continue.

Login tab

"Login" tab of "Gramps Web Sync" tool addon

On the Login tab provide your Gramps Web credentials to be used for the Synchronization then select Next to continue.

Beyond this it is recommended to see the current instructions Synchronize with Gramps page from the Gramps Web User Guide for further information.

See also

Gramps Web support discourse forum: (About the category)

• Category search for sync
• Category
• Gramps Web