listmonk

by knadh

knadh / listmonk

High performance, self-hosted newsletter and mailing list manager with a modern dashboard. Go + VueJ...

4.0K Stars 229 Forks Last release: 3 months ago (v0.7.0-alpha) GNU Affero General Public License v3.0 403 Commits 18 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

listmonk

listmonk is a standalone, self-hosted, newsletter and mailing list manager. It is fast, feature-rich, and packed into a single binary. It uses a PostgreSQL database as its data store.

listmonk-dashboard Visit listmonk.app

listmonk is alpha software and may change and break. Use with caution. That said, it has been in active use at zerodha.com where it has processed hundreds of campaigns and tens of millions of e-mails.

Installation

Docker

The latest image is available on DockerHub at

listmonk/listmonk:latest
. Use the sample docker-compose.yml to run listmonk and Postgres DB with docker-compose as follows:

Demo

docker-compose up -d demo-db demo-app

The demo does not persist Postgres after the containers are removed. DO NOT use this demo setup in production.

Production

  • docker-compose up db
    to run the Postgres DB.
  • docker-compose run --rm app ./listmonk --install
    to setup the DB (or
    --upgrade
    to upgrade an existing DB)
  • Run
    docker-compose up app
    and visit
    http://localhost:9000
    .

More information on docs.


Binary

  • Download the latest release and extract the listmonk binary.
  • ./listmonk --new-config
    to generate config.toml. Then, edit the file.
  • ./listmonk --install
    to setup the Postgres DB (or
    --upgrade
    to upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).
  • Run
    ./listmonk
    and visit
    http://localhost:9000
    .

Heroku

Using the Nginx buildpack can be used to deploy listmonk on Heroku and use Nginx as a proxy to setup basicauth. This one-click Heroku deploy button provides an automated default deployment.

Deploy

Please note that configuration options must be set using environment configuration variables.

Developers

listmonk is a free and open source software licensed under AGPLv3. If you are interested in contributing, refer to the developer setup. The backend is written in Go and the frontend is Vue with Buefy for UI.

License

listmonk is licensed under the AGPL v3 license.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.