listmonk

Go to file

Kailash Nadh 6f2f361cac Merge pull request #252 from mr-karan/master feat: Add shell script for demo setup		2021-01-22 09:16:07 +05:30
cmd	feat: Set default values for DB connection parameters	2020-11-17 14:34:35 +05:30
frontend	Bump axios from 0.19.2 to 0.21.1 in /frontend	2021-01-06 06:20:31 +00:00
internal	Log subscriber UUID in message send errors	2020-10-24 14:24:22 +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	Add (Open/Net/Free)BSD to cross-platform release builds.	2020-10-18 22:48:00 +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 --version string and duplicate printing	2020-10-18 22:59:22 +05:30
README.md	feat: Add shell script for demo setup	2021-01-21 21:53:49 +05:30
TODO.md	Remove completed items	2020-05-25 11:55:02 +05:30
config-demo.toml	feat: Set default values for DB connection parameters	2020-11-17 14:34:35 +05:30
config.toml.sample	feat: Set default values for DB connection parameters	2020-11-17 14:34:35 +05:30
docker-compose.yml	feat: Add separate config for demo setup, tweak docs	2020-07-08 22:38:31 +05:30
go.mod	Update smtppool lib adding support for Unicode in e-mail IDs	2020-10-17 23:35:03 +05:30
go.sum	Update smtppool lib adding support for Unicode in e-mail IDs	2020-10-17 23:35:03 +05:30
install-demo.sh	feat: Add shell script for demo setup	2021-01-21 21:53:49 +05:30
queries.sql	Refactor get-lists query for speed	2020-11-21 17:29:24 +05:30
schema.sql	Fix invalid link click registrations	2020-10-24 14:03:37 +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

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

mkdir listmonk-demo
sh -c "$(curl -sSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)"

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.