Addon:Gramps Web

From Gramps
Revision as of 22:39, 18 November 2022 by Bamaustin (talk | contribs) (Uploading fresh tree data to Gramps Web)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Gnome-important.png
Early adopters can try Gramps Web starting 1st quarter of 2022

Since the project is in an early stage, remember to frequently generate backups when you use this tool with your genealogical data.

Fig. 1 GrampsWeb screenshot from GitHub project docs

Gramps Web is a web app developed by the Gramps community that allows authorized users to collaboratively edit genealogical information using a Gramps family tree database.

Is Gramps Web an add-on within Gramps?

No, Gramps Web runs on a server and is accessed via the web browser. It is not part of your desktop Gramps application.

Gramps Web is for limited simultaneous use by a number of authenticated users. It not meant to be exposed to the internet for unlimited public access. (More general access would demand a powerful server or expensive hosting.) User accounts can be created by the site owner via the command line or web interface, or by self-registration and subsequent approval by the site owner.

The server may be remote at a hosted service or on your local network. The supported architectures for local network include not only x86-64 (desktop systems), but also ARM systems such as a Raspberry Pi, which can serve as a low-cost, but powerful (enough) web server.

Gramps Web is a separate project based on the same code base as Gramps Desktop. It uses the Gramps Python library at its core to provide a REST API backend service leveraging the genealogical functions and database handling of Gramps. On top, it serves a modern, mobile-first web frontend.

Deploying a Gramps Web instance

Configuring a Gramps Web instance on your own server or hosted service is an EXPERT level task. But there are deployment options using a Docker container and a turnkey "1-click App" offered as a service if you have a (paid) Digital Oceans droplet account.

Uploading fresh tree data to Gramps Web

Gramps Web Sync addon snychronizes the Gramps Web online database with Gramps Desktop from the Tools -> Family Tree Processing submenu. It supports import and export of genealogical data in all formats supported by Gramps.

See the project documentation on GitHub.

Features

  • Browse all objects in your family tree: people, families, events, places, repositories, sources, citations, media objects, and notes
  • Two different interactive pedigree views
  • Display all places on an interactive, searchable map
  • Blog section with blog articles stored in Gramps
  • Switch the language of the interface between any of 40 languages
  • Multi-user system with different levels of permissions
  • Edit all objects collaboratively and add new objects
  • Fully responsive & mobile friendly
  • Export the tree as Gramps XML or GEDCOM from the web interface
  • Import a tree (in Gramps XML or GEDCOM format)
  • Generate any report supported by Gramps from the web interface
  • Synchronize with your local Gramps database and use Gramps desktop in parallel
  • Tag people in photos with automatic face detection

Setup Requirements

Gramps Web is a web app that runs on a server and is accessed via the web browser. It is meant to be made accessible to authenticated users via the internet.

Server Requirements

The most convenient way to host Gramps Web is via Docker Compose. While this is not possible with ordinary "shared hosting" providers, this makes it possible to host the app on Linux, Mac, or Windows; it can be hosted on a virtual server or on a Raspberry Pi (we provide Docker images for the ARM architecture) in your basement.

Apart from Docker, you will also need some storage space to store your media files (images, documents).

Finally, Gramps Web is only secure when served via HTTPS, so you will require an SSL/TLS certificate.

Gnome-important.png

Gramps Web is a full Gramps instance running on a web server that you can synchronize with your Desktop Gramps. Admittedly, installing it is not trivial. This is an Expert level task. There is a Docker container to simplify the deployment somewhat.

The easiest option at the moment is described here: Gramps Web 1-click app using a (for pay) droplet account on DigitalOcean.

See Also