Self-host Plunk on a VPS

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

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

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

Specification

Status
Listed
Category
Communication
Services
db, plunk, redis
Ports
3000
Volumes
2
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
4

About Plunk

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

What it deploys

Plunk runs as 3 services in a single Compose app, listening on port 3000, with 2 named volume mounts.

ServiceImageTagPortsVolumes
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

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.

Settings and environment

You must set AWS_ACCESS_KEY_ID, AWS_REGION, AWS_SECRET_ACCESS_KEY, AWS_SES_CONFIGURATION_SET. 3 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template
plunkAPI_URIPreset by the template
plunkAPP_URIPreset by the template
plunkAWS_ACCESS_KEY_IDYou must set this
plunkAWS_REGIONYou must set this
plunkAWS_SECRET_ACCESS_KEYYou must set this
plunkAWS_SES_CONFIGURATION_SETYou must set this
plunkDATABASE_URLGenerated at deploy
plunkDISABLE_SIGNUPSPreset by the template
plunkJWT_SECRETGenerated at deploy
plunkNEXT_PUBLIC_API_URIPreset by the template
plunkNODE_OPTIONSPreset by the template
plunkREDIS_URLPreset by the template

Install Plunk 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 plunk
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default. Replace VALUE with your own AWS_ACCESS_KEY_ID, AWS_REGION, AWS_SECRET_ACCESS_KEY, AWS_SES_CONFIGURATION_SET.

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

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install plunk --name my-plunk --domain db=plunk.example.com

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

More in Communication

All Communication templates