# Self-host Gramps Web

> An online genealogy system for researching and sharing family trees.

- Page: https://levelrail.com/templates/gramps-web/
- JSON: https://levelrail.com/templates/gramps-web.json
- Category: Productivity
- Licence: AGPL-3.0-or-later (Network copyleft (AGPL) license)
- Source: https://github.com/gramps-project/gramps-web
- Upstream docs: https://www.grampsweb.org/install_setup/setup/

## Requirements
- Memory: about 1 GiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 25.9.0

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| grampsweb | ghcr.io/gramps-project/grampsweb | 25.9.0 | 5000 | gramps_users -> /app/users; gramps_index -> /app/indexdir; gramps_thumb_cache -> /app/thumbnail_cache; gramps_cache -> /app/cache; gramps_secret -> /app/secret; gramps_db -> /root/.gramps/grampsdb; gramps_media -> /app/media; gramps_tmp -> /tmp |
| grampsweb_redis | redis | 7-alpine | none | none |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| grampsweb | GRAMPSWEB_CELERY_CONFIG__broker_url | preset |
| grampsweb | GRAMPSWEB_CELERY_CONFIG__result_backend | preset |
| grampsweb | GRAMPSWEB_RATELIMIT_STORAGE_URI | preset |
| grampsweb | GRAMPSWEB_SECRET_KEY | generated |
| grampsweb | GRAMPSWEB_TREE | preset |
| grampsweb | GUNICORN_NUM_WORKERS | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy gramps-web --name my-gramps-web
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/gramps-web/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### Can I deploy Gramps Web on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Gramps Web, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/gramps-project/grampsweb:25.9.0, redis:7-alpine is what you deploy there.

Self-host Gramps Web, Gramps Web docker compose file, deploy Gramps Web on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
