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=VALUESpecification
- 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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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.
| Service | Variable | Value |
|---|---|---|
| db | POSTGRES_DB | Preset by the template |
| db | POSTGRES_PASSWORD | Generated at deploy |
| db | POSTGRES_USER | Preset by the template |
| plunk | API_URI | Preset by the template |
| plunk | APP_URI | Preset by the template |
| plunk | AWS_ACCESS_KEY_ID | You must set this |
| plunk | AWS_REGION | You must set this |
| plunk | AWS_SECRET_ACCESS_KEY | You must set this |
| plunk | AWS_SES_CONFIGURATION_SET | You must set this |
| plunk | DATABASE_URL | Generated at deploy |
| plunk | DISABLE_SIGNUPS | Preset by the template |
| plunk | JWT_SECRET | Generated at deploy |
| plunk | NEXT_PUBLIC_API_URI | Preset by the template |
| plunk | NODE_OPTIONS | Preset by the template |
| plunk | REDIS_URL | Preset by the template |
Install Plunk on a VPS
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get plunk -
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=VALUETo 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.
Docs and upstream
More in Communication
- PostizSchedules and publishes posts across social platforms from one calendar, with basic analytics.
- Rocket.ChatA full-featured, self-hosted team chat platform with video calls and app integrations.
- Roundcube WebmailA browser-based IMAP email client with a clean interface, address books, and plugin support.
- Once CampfireA simple, self-hosted group chat app from 37signals, no subscription required.
- ntfyA simple pub-sub push notification service you can send alerts to from any script or app.
- NodeBBA modern forum platform with real-time discussions, SSO, and a plugin ecosystem, backed by Postgres.