Self-host Gramps Web with Levelrail

An online genealogy system for researching and sharing family trees.

  • Authorgramps-project
  • LicenceAGPL-3.0-or-later
  • Memory1 GiB
  • Archarm64
  • Services2

How to self-host Gramps Web

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • ghcr.io/gramps-project/grampsweb:25.9.0
    • redis:7-alpine
  2. Create the app

    2 services start in a single Compose app, with 8 named volume mounts for your data, on port 5000.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 5 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Gramps Web requirements

Memory
About 1 GiB
Architectures
amd64 image published, arm64 image published
Ports
5000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0-or-later, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 5000 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Gramps Web. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Gramps Web docs page.

Deploy Gramps Web your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Gramps Web from the CLI

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

Deploy Gramps Web with the API

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

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

Gramps Web configuration

Gramps Web services

ServiceImagePortsVolumes
grampsweb ghcr.io/gramps-project/grampsweb:25.9.0 5000 gramps_users -> /app/usersgramps_index -> /app/indexdirgramps_thumb_cache -> /app/thumbnail_cachegramps_cache -> /app/cachegramps_secret -> /app/secretgramps_db -> /root/.gramps/grampsdbgramps_media -> /app/mediagramps_tmp -> /tmp
grampsweb_redis redis:7-alpine none none

Gramps Web environment variables

VariableServiceValue
GRAMPSWEB_CELERY_CONFIG__broker_url grampsweb Preset by the template
GRAMPSWEB_CELERY_CONFIG__result_backend grampsweb Preset by the template
GRAMPSWEB_RATELIMIT_STORAGE_URI grampsweb Preset by the template
GRAMPSWEB_SECRET_KEY grampsweb Generated at deploy
GRAMPSWEB_TREE grampsweb Preset by the template
GUNICORN_NUM_WORKERS grampsweb Preset by the template

Ports and volumes

Ports
5000
Volumes
8 named mounts: 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

Gramps Web FAQ

How much memory does Gramps Web need?

The catalog lists about 1 GiB of memory for Gramps Web across its 2 services.

Does Gramps Web run on arm64?

For Gramps Web, an arm64 image is published; amd64 is image published.

What licence is Gramps Web under?

Gramps Web is licensed under AGPL-3.0-or-later, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does Gramps Web need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does Gramps Web bundle?

The template includes Redis, running as its own service.

Which ports does Gramps Web use?

Gramps Web listens on port 5000 inside the stack.

Where does Gramps Web keep its data?

In named volumes: gramps_users mounted at /app/users, gramps_index mounted at /app/indexdir, gramps_thumb_cache mounted at /app/thumbnail_cache and gramps_cache mounted at /app/cache.

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.

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