Self-host Plunk with Levelrail

An email platform for transactional mail, marketing campaigns and automations that sends through your own AWS SES account.

  • Authoruseplunk
  • LicenceAGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services3

Needs setup: set AWS_ACCESS_KEY_ID, AWS_REGION, AWS_SECRET_ACCESS_KEY, AWS_SES_CONFIGURATION_SET before the first start.

How to self-host Plunk

  1. Pull the images

    3 images are pulled on your server.

    Show images
    • postgres:16-alpine
    • driaug/plunk:1.3.6
    • redis:7.4-alpine
  2. Create the app

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

  3. Fill in the secrets

    3 secrets are generated and stored encrypted, 8 settings are preset, you provide 4 values.

  4. Open it

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

Plunk requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
3000
Domain
Optional, an sslip.io address is used without one
Settings
4 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 Plunk. 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 Plunk docs page.

Deploy Plunk your way

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

Deploy Plunk from the CLI

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

levelrail-cli templates install plunk --name my-plunk --env AWS_REGION=VALUE --env AWS_ACCESS_KEY_ID=VALUE --env AWS_SECRET_ACCESS_KEY=VALUE --env AWS_SES_CONFIGURATION_SET=VALUE

Deploy Plunk 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/plunk/install \
  -d '{
    "name": "my-plunk",
    "env": { "AWS_REGION": "VALUE", "AWS_ACCESS_KEY_ID": "VALUE", "AWS_SECRET_ACCESS_KEY": "VALUE", "AWS_SES_CONFIGURATION_SET": "VALUE" }
  }'

Plunk configuration

Plunk services

ServiceImagePortsVolumes
db postgres:16-alpine none pgdata -> /var/lib/postgresql/data
plunk driaug/plunk:1.3.6 3000 none
redis redis:7.4-alpine none redis -> /data

Plunk environment variables

VariableServiceValue
POSTGRES_DB db Preset by the template
POSTGRES_PASSWORD db Generated at deploy
POSTGRES_USER db Preset by the template
API_URI plunk Preset by the template
APP_URI plunk Preset by the template
AWS_ACCESS_KEY_ID plunk You must set this
AWS_REGION plunk You must set this
AWS_SECRET_ACCESS_KEY plunk You must set this
Show all 15 variables
  • AWS_SES_CONFIGURATION_SETplunkYou must set this
  • DATABASE_URLplunkGenerated at deploy
  • DISABLE_SIGNUPSplunkPreset by the template
  • JWT_SECRETplunkGenerated at deploy
  • NEXT_PUBLIC_API_URIplunkPreset by the template
  • NODE_OPTIONSplunkPreset by the template
  • REDIS_URLplunkPreset by the template

Ports and volumes

Ports
3000
Volumes
2 named mounts: pgdata -> /var/lib/postgresql/data, redis -> /data

Plunk FAQ

How much memory does Plunk need?

The catalog lists about 512 MiB of memory for Plunk across its 3 services.

Does Plunk run on arm64?

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

What licence is Plunk under?

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

Does Plunk need configuration before it starts?

Yes. Plunk has required settings: AWS_ACCESS_KEY_ID, AWS_REGION, AWS_SECRET_ACCESS_KEY and AWS_SES_CONFIGURATION_SET.

Which database does Plunk bundle?

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

Which ports does Plunk use?

Plunk listens on port 3000 inside the stack.

Where does Plunk keep its data?

In named volumes: pgdata mounted at /var/lib/postgresql/data and redis mounted at /data.

Can I deploy Plunk 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 plunk for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image postgres:16-alpine, driaug/plunk:1.3.6, redis:7.4-alpine is what you deploy there.

levelrail-cli templates install plunk --name my-plunk --env AWS_REGION=VALUE --env AWS_ACCESS_KEY_ID=VALUE --env AWS_SECRET_ACCESS_KEY=VALUE --env AWS_SES_CONFIGURATION_SET=VALUE