listmonk

Go to file

Kailash Nadh 4ddaba889f Merge branch 'master' of github.com:knadh/listmonk		2021-04-17 13:36:53 +05:30
.github/workflows	fix: rename Github Token secret variable	2021-03-19 15:57:00 +05:30
cmd	Add `preconfirm_subscriptions=true/false`new subs API.	2021-04-17 13:34:37 +05:30
frontend	Add `preconfirm_subscriptions=true/false`new subs API.	2021-04-17 13:34:37 +05:30
i18n	Finished Polish (pl) translations	2021-04-16 09:53:09 +02:00
internal	Add `preconfirm_subscriptions=true/false`new subs API.	2021-04-17 13:34:37 +05:30
models	Add markdown support to campaign content.	2021-04-14 12:26:09 +05:30
scripts	Add script to merge and normalize i18n files	2021-04-14 13:52:13 +05:30
static	Add `preconfirm_subscriptions=true/false`new subs API.	2021-04-17 13:34:37 +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: remove deprecated syntax in goreleaser	2021-03-19 12:21:35 +05:30
Dockerfile	Including an EXPOSE instruction in the Dockerfile	2021-02-19 18:34:09 +01:00
LICENSE	Refactor and add new build routines	2019-07-09 15:57:04 +05:30
Makefile	Build static Go binary	2021-04-11 15:07:19 +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	Fix indentation of docker-compose file	2021-04-11 15:07:20 +05:30
go.mod	Add markdown support to campaign content.	2021-04-14 12:26:09 +05:30
go.sum	Add markdown support to campaign content.	2021-04-14 12:26:09 +05:30
install-demo.sh	feat: Add shell script for demo setup	2021-01-21 21:53:49 +05:30
queries.sql	Add `preconfirm_subscriptions=true/false`new subs API.	2021-04-17 13:34:37 +05:30
schema.sql	Add markdown support to campaign content.	2021-04-14 12:26:09 +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.