Self-host Gramps Web on a VPS

An online genealogy system for researching and sharing family trees.

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

Specification

Status
Listed
Category
Productivity
Services
grampsweb, grampsweb_redis
Ports
5000
Volumes
8
Memory
about 1 GiB
arm64
image published
amd64
image published
Settings to fill in
none

About Gramps Web

An online genealogy system for researching and sharing family trees. Runs 2 containers (grampsweb, grampsweb_redis), with grampsweb listening on port 5000; data is kept in named volumes.

What it deploys

Gramps Web runs as 2 services in a single Compose app, listening on port 5000, with 8 named volume mounts.

ServiceImageTagPortsVolumes
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

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 5000 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
grampswebGRAMPSWEB_CELERY_CONFIG__broker_urlPreset by the template
grampswebGRAMPSWEB_CELERY_CONFIG__result_backendPreset by the template
grampswebGRAMPSWEB_RATELIMIT_STORAGE_URIPreset by the template
grampswebGRAMPSWEB_SECRET_KEYGenerated at deploy
grampswebGRAMPSWEB_TREEPreset by the template
grampswebGUNICORN_NUM_WORKERSPreset by the template

Install Gramps Web on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get gramps-web
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

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

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Gramps Web.

More in Productivity

All Productivity templates