listmonk

Go to file

Kailash Nadh 8dbe30cd26 Add new 'Logs' page to the UI to view stdout logs		2020-10-10 23:55:54 +05:30
cmd	Add new 'Logs' page to the UI to view stdout logs	2020-10-10 23:55:54 +05:30
frontend	Add new 'Logs' page to the UI to view stdout logs	2020-10-10 23:55:54 +05:30
internal	Add new 'Logs' page to the UI to view stdout logs	2020-10-10 23:55:54 +05:30
models	Add generic HTTP postback `Messenger` support.	2020-10-10 18:52:08 +05:30
static	Add rebranded design elements.	2020-08-09 19:15:44 +05:30
.dockerignore	feat: Add blobstore package	2019-10-31 11:25:31 +05:30
.gitattributes	Add .gitattributes for github-linguist	2019-07-15 09:34:56 +05:30
.gitignore	feat: Add separate config for demo setup, tweak docs	2020-07-08 22:38:31 +05:30
.goreleaser.yml	Fix build scripts (and static file embed)	2020-08-09 20:02:43 +05:30
Dockerfile	feat: Add separate config for demo setup, tweak docs	2020-07-08 22:38:31 +05:30
LICENSE	Refactor and add new build routines	2019-07-09 15:57:04 +05:30
Makefile	fix: incorrect git tag being injected as version	2020-10-03 03:55:39 +05:30
README.md	Add zerodha.tech badge	2020-09-21 23:46:57 +05:30
TODO.md	Remove completed items	2020-05-25 11:55:02 +05:30
config-demo.toml	Refactor `blacklist` to `blocklist`	2020-08-01 16:45:29 +05:30
config.toml.sample	Add BasicAuth to admin endpoints.	2020-08-08 13:11:49 +05:30
docker-compose.yml	feat: Add separate config for demo setup, tweak docs	2020-07-08 22:38:31 +05:30
go.mod	Add generic HTTP postback `Messenger` support.	2020-10-10 18:52:08 +05:30
go.sum	Add generic HTTP postback `Messenger` support.	2020-10-10 18:52:08 +05:30
queries.sql	Allow deleting of all campaigns irrespective of status	2020-10-10 22:08:13 +05:30
schema.sql	Add support for automatic, idempotent DB migrations	2020-08-03 19:02:23 +05:30
stats.sql	Add support for campaign view tracking with {{ TrackView }} pixel tag	2018-11-02 13:20:32 +05:30

README.md

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.

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.

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.