beenull/listmonk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
375 commits 4 branches 29 tags 19 MiB
Go 40.7%
JavaScript 27.2%
Vue 26%
HTML 1.9%
SCSS 1.8%
Other 2.3%
Find a file
Kailash Nadh fd05f8db21
Merge pull request #190 from rwilhelm/patch-1 
Fix typo
2020-09-19 12:08:43 +05:30
cmd Fix incorrect default values and server response in list creation UI 2020-08-22 14:13:13 +05:30
frontend Update Settings.vue 2020-09-19 00:11:42 +02:00
internal Add BasicAuth to admin endpoints. 2020-08-08 13:11:49 +05:30
models Refactor blacklist to blocklist 2020-08-01 16:45:29 +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
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
Dockerfile feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
go.mod Add BasicAuth to admin endpoints. 2020-08-08 13:11:49 +05:30
go.sum Add BasicAuth to admin endpoints. 2020-08-08 13:11:49 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
Makefile Fix build scripts (and static file embed) 2020-08-09 20:02:43 +05:30
queries.sql Fix missing status column in import that affects auto-migrated 2020-09-02 11:40:34 +05:30
README.md Typo in README 2020-08-29 11:34:30 +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
TODO.md Remove completed items 2020-05-25 11:55:02 +05:30

README.md

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.