Self-host HeyForm with Levelrail

A form builder for surveys, quizzes and lead capture, with conversational forms and a MongoDB backend.

  • Authorheyform
  • LicenceAGPL-3.0
  • Memory768 MiB
  • Archarm64
  • Services3

How to self-host HeyForm

  1. Pull the images

    3 images are pulled on your server.

    Show images
    • heyform/community-edition:v3.0.3
    • mongo:7
    • redis:7-alpine
  2. Create the app

    3 services start in a single Compose app, with 3 named volume mounts for your data, on port 9157.

  3. Fill in the secrets

    4 secrets are generated and stored encrypted, 4 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.

HeyForm requirements

Memory
About 768 MiB
Architectures
amd64 image published, arm64 image published
Ports
9157
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then HeyForm. 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 HeyForm docs page.

Deploy HeyForm your way

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

Deploy HeyForm from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain heyform=app.example.com.

levelrail-cli templates install heyform --name my-heyform

Deploy HeyForm with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/heyform/install \
  -d '{
    "name": "my-heyform"
  }'

HeyForm configuration

HeyForm services

ServiceImagePortsVolumes
heyform heyform/community-edition:v3.0.3 9157 assets -> /app/static/upload
mongo mongo:7 none mongo -> /data/db
redis redis:7-alpine none redis -> /data

HeyForm environment variables

VariableServiceValue
APP_HOMEPAGE_URL heyform Preset by the template
FORM_ENCRYPTION_KEY heyform Generated at deploy
MONGO_URI heyform Preset by the template
REDIS_HOST heyform Preset by the template
REDIS_PASSWORD heyform Generated at deploy
REDIS_PORT heyform Preset by the template
SESSION_KEY heyform Generated at deploy
REDIS_PASSWORD redis Generated at deploy

Ports and volumes

Ports
9157
Volumes
3 named mounts: assets -> /app/static/upload, mongo -> /data/db, redis -> /data

HeyForm FAQ

How much memory does HeyForm need?

The catalog lists about 768 MiB of memory for HeyForm across its 3 services.

Does HeyForm run on arm64?

For HeyForm, an arm64 image is published; amd64 is image published.

What licence is HeyForm under?

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

Does HeyForm need configuration before it starts?

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

Which database does HeyForm bundle?

The template includes MongoDB and Redis, running as its own service.

Which ports does HeyForm use?

HeyForm listens on port 9157 inside the stack.

Where does HeyForm keep its data?

In named volumes: assets mounted at /app/static/upload, mongo mounted at /data/db and redis mounted at /data.

Can I deploy HeyForm on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id heyform for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image heyform/community-edition:v3.0.3, mongo:7, redis:7-alpine is what you deploy there.

levelrail-cli templates install heyform --name my-heyform