selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

gramps-web-api logo

Self-host gramps-web-api

v3.24.0

RESTful web API for Gramps genealogy database

ReleaseOpen SourceAGPL-3.0
Docker ComposeCompose file & guide
docker compose up -d
Updated10 hours ago
LanguagePython
Setup difficultyModerate
MobilePWA
Stars
229
Port
5000 (HTTP API)
Docker
ghcr.io/gramps-project/grampsweb
gramps-web-api screenshot 1gramps-web-api screenshot 2gramps-web-api screenshot 3gramps-web-api screenshot 4gramps-web-api screenshot 5gramps-web-api screenshot 6gramps-web-api screenshot 7gramps-web-api screenshot 8gramps-web-api screenshot 9gramps-web-api screenshot 10

What is gramps-web-api?

Gramps Web API is a Python REST API that gives programmatic access to family tree databases built with Gramps genealogy software. It acts as the backend for Gramps Web, a collaborative web-based genealogy application, but can also be used on its own. The API lets you query and modify people, families, events, places, sources, citations, media, and notes. It includes DNA match analysis with a chromosome browser and Y-DNA haplogroup determination, an AI-powered chat assistant for querying the family tree, full revision history with undo, privacy controls, and two-way synchronization with Gramps Desktop. Deployment uses Docker Compose with Redis for background tasks, and optionally PostgreSQL for multi-tree setups and S3-compatible storage for media. Licensed under AGPL-3.0.

Should you self-host gramps-web-api?

gramps-web-api scores 52/100 on selfhost.directory (how scoring works) and ranks #3 of 5 in Research. It has 229 GitHub stars.

It shipped 20 stable releases in the past year. The latest, v3.24.0, came out on 17 October 2026. New versions land roughly every 7 days.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is AGPL-3.0-licensed and written mostly in Python.

Its closest alternative on selfhost.directory is gramps-web (66/100, 1 782 stars). It scores higher overall, so compare the two before you pick. See gramps-web-api vs gramps-web side by side.

Features

  • AI Assistant
  • Blog and storytelling
  • Data Import and Export
  • DNA analysis
  • Face detection and photo tagging
  • Gramps Desktop synchronization
  • Interactive family tree graphs
  • Multi-language Support
  • Privacy levels and user access control
  • Progressive Web App
  • Report Generation
  • REST API for Gramps data
  • Revision history with undo
  • Task Management
  • Timeline and map views

gramps-web-api README

How to install gramps-web-api

Install gramps-web-api with Docker Compose

Docker and Docker Compose

Create a new file on the server named docker-compose.yml and insert the following contents: docker-compose.yml.

Run

docker compose up -d

On first run, the app will display a first-run wizard that will allow you to

  • Create an account for the owner (admin) user
  • Set some necessary configuration options
  • Import a family tree in Gramps XML (.gramps) format

Requires Docker and Docker Compose installed. Supported on Windows, Mac OS, or Linux (x86-64 and ARM including Raspberry Pi).

gramps-web-api releases & version history

More in Research

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…