Portainer Templates logo

Portainer Templates

Listmonk Listmonk

Stack

EmailMarketing

High performance self-hosted newsletter and mailing list manager with a modern dashboard. Source: https://github.com/knadh/listmonk

Source details

Repo: knadh/listmonk
Stars: 22.9k
Forks: 3k
Language: Go
License: AGPL-3.0
Latest: v6.2.0 · 1 month ago
Updated: 1 day ago
Website: listmonk.app/

Configuration

Type
Compose
Platform
linux
Env vars
LISTMONK_ADMIN_USER=adminLISTMONK_ADMIN_PASSWORD=
Source
Repo

Source

Services

listmonk

Configuration

Image
listmonk/listmonk:latest
Command
sh,-c,./listmonk --install --idempotent --yes --config '' && ./listmonk --upgrade --yes --config '' && ./listmonk --config ''
Ports
9000:9000
Volumes
/listmonk/uploads : listmonk-uploads
Env vars
LISTMONK_app__address=0.0.0.0:9000LISTMONK_ADMIN_USER=${LISTMONK_ADMIN_USER:-admin}LISTMONK_ADMIN_PASSWORD=${LISTMONK_ADMIN_PASSWORD:-}LISTMONK_db__host=postgresLISTMONK_db__port=5432LISTMONK_db__user=listmonkLISTMONK_db__password=listmonkLISTMONK_db__database=listmonkLISTMONK_db__ssl_mode=disableTZ=Etc/UTC
Restart
unless-stopped

Image details

Pulls: 8.0M
User: listmonk
Created: Jul 12, 2019
Updated: 9 days ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=listmonkPOSTGRES_USER=listmonkPOSTGRES_PASSWORD=listmonk
Restart
unless-stopped

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 38 minutes ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Listmonk

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Listmonk, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  listmonk:
    image: listmonk/listmonk:latest
    restart: unless-stopped
    ports:
      - "9000:9000"
    command:
      [sh, -c, "./listmonk --install --idempotent --yes --config '' && ./listmonk --upgrade --yes --config '' && ./listmonk --config ''"]
    environment:
      - LISTMONK_app__address=0.0.0.0:9000
      # Super-admin seeded on first install (leave password blank to use the first-run setup screen)
      - LISTMONK_ADMIN_USER=${LISTMONK_ADMIN_USER:-admin}
      - LISTMONK_ADMIN_PASSWORD=${LISTMONK_ADMIN_PASSWORD:-}
      - LISTMONK_db__host=postgres
      - LISTMONK_db__port=5432
      - LISTMONK_db__user=listmonk
      - LISTMONK_db__password=listmonk
      - LISTMONK_db__database=listmonk
      - LISTMONK_db__ssl_mode=disable
      - TZ=Etc/UTC
    volumes:
      - listmonk-uploads:/listmonk/uploads
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_DB=listmonk
      - POSTGRES_USER=listmonk
      - POSTGRES_PASSWORD=listmonk
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U listmonk"]
      interval: 10s
      timeout: 5s
      retries: 6

volumes:
  listmonk-uploads:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/listmonk.yml up -d

More install options in our documentation, or see knadh/listmonk for app-specific guidance.

Container Documentation

listmonk Documentation

High performance, self-hosted newsletter and mailing list manager with a modern dashboard

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve Listmonk on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying listmonk.example.com to http://listmonk:9000

Add this to your Caddyfile

listmonk.example.com {
	reverse_proxy http://listmonk:9000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:9000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :9000
  • Stop the other service, or pick a different host port. In 9000:9000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:9000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, listmonk can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 9000

Image won't pull

Test the pull directly on the host: docker pull listmonk/listmonk:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Listmonk is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • listmonk runs listmonk/listmonk:latest, starts after postgres
  • postgres runs postgres:17-alpine

Ports

A port is the door the app answers on. A mapping like 9000:9000 means it's reachable on port 9000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:9000 in a browser. It opens:

  • 9000:9000, likely the web interface

Volumes

A volume is where Listmonk keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /listmonk/uploads kept in the listmonk-uploads volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Listmonk takes 13 of them, all with defaults you can leave alone or tweak:

  • LISTMONK_app__address, defaults to 0.0.0.0:9000
  • LISTMONK_ADMIN_USER, defaults to admin
  • LISTMONK_ADMIN_PASSWORD, pulled from your own environment
  • LISTMONK_db__host, defaults to postgres
  • LISTMONK_db__port, defaults to 5432
  • LISTMONK_db__user, defaults to listmonk
  • LISTMONK_db__password, defaults to listmonk
  • LISTMONK_db__database, defaults to listmonk
  • LISTMONK_db__ssl_mode, defaults to disable
  • TZ, defaults to Etc/UTC
  • POSTGRES_DB, defaults to listmonk
  • POSTGRES_USER, defaults to listmonk
  • POSTGRES_PASSWORD, defaults to listmonk

Restart policy

The restart policy here is unless-stopped, so Docker restarts Listmonk after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like listmonk) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Listmonk is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Listmonk up. Add the template list to Portainer once, then deploying Listmonk is a click rather than a wall of config.