Go to file
Kailash Nadh 2c18d6356b
Merge pull request #24 from shailysangwan/master
update instructions for local installation
2019-10-23 17:17:31 +05:30
email-templates Fix default template rendering in Gmail with CSS inlining 2019-07-21 20:45:37 +05:30
frontend fix: responsive layour fixes for table, modal and form fields 2019-09-09 00:14:16 +05:30
manager Refactor Messenger/Emailer to accept attachments 2019-07-18 12:40:48 +05:30
messenger Add helper to make mail attachment headers 2019-07-21 12:30:51 +05:30
models Add pagination to the lists page 2019-05-14 16:41:05 +05:30
public Refactor "unsubscribe from all" (self-blacklist) behaviour. 2019-07-21 20:45:35 +05:30
subimporter Update list date on import before notif and run notif as a goroutine 2019-05-14 22:18:18 +05:30
.gitattributes Add .gitattributes for github-linguist 2019-07-15 09:34:56 +05:30
.gitignore fix: Path for windows build in goreleaser 2019-07-12 15:44:44 +05:30
.goreleaser.yml fix: Path for windows build in goreleaser 2019-07-12 15:44:44 +05:30
Dockerfile feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
INSTALL.md fix: docker-compose command 2019-07-20 17:49:41 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
Makefile fix: buildString having incorrect TZ data 2019-09-06 13:43:49 +05:30
README.md update instructions for local installation 2019-10-23 17:06:03 +05:30
TODO.md Add TODO 2019-04-07 09:42:50 +05:30
admin.go Rename 'runner.Runner' to 'manager.Manager' 2018-12-19 12:03:13 +05:30
campaigns.go Fix 'send later' switch + date not updating on campaign edit 2019-08-26 23:45:18 +05:30
config.toml.sample Refactor "unsubscribe from all" (self-blacklist) behaviour. 2019-07-21 20:45:35 +05:30
docker-compose.yml feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
go.mod Add data privacy export / wipe features (aimed at GDPR compliance). 2019-07-21 19:21:23 +05:30
go.sum Add data privacy export / wipe features (aimed at GDPR compliance). 2019-07-21 19:21:23 +05:30
handlers.go Check subscriber existence by UUID on public pages 2019-07-21 21:58:25 +05:30
import.go Refactor and fix importer state bugs 2019-04-03 14:08:31 +05:30
install.go Fix `from` e-mail ID in dummy campaign on install 2019-07-16 19:51:41 +05:30
lists.go Add pagination to the lists page 2019-05-14 16:41:05 +05:30
main.go feat: read config from env 2019-10-01 16:54:50 +05:30
manager_db.go Refactor campaigns query into two: 'query' and 'get' 2019-03-30 12:38:02 +05:30
media.go Fresh start 2018-10-25 19:21:47 +05:30
notifications.go Add data privacy export / wipe features (aimed at GDPR compliance). 2019-07-21 19:21:23 +05:30
public.go Fix error message 2019-07-21 21:55:12 +05:30
queries.go Remove orphan func 2019-07-21 21:22:26 +05:30
queries.sql Fix 'send later' switch + date not updating on campaign edit 2019-08-26 23:45:18 +05:30
schema.sql Remove stub user features and handlers. 2019-06-26 16:22:47 +05:30
stats.sql Add support for campaign view tracking with {{ TrackView }} pixel tag 2018-11-02 13:20:32 +05:30
subscribers.go Add data privacy export / wipe features (aimed at GDPR compliance). 2019-07-21 19:21:23 +05:30
templates.go Remove redundant error wrapper 2018-12-26 15:38:08 +05:30
utils.go Refactor "error" view to a generic "message" 2019-07-18 12:44:46 +05:30

README.md

listmonk

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

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-splash

Installation and use

  • Download the latest release for your platform and extract the listmonk binary. For example: tar -C $HOME/listmonk -xzf listmonk_$VERSION_$OS_$ARCH.tar.gz
  • Navigate to the directory containing the binary (cd $HOME/listmonk) and run ./listmonk --new-config to generate a sample config.toml and add your configuration (SMTP and Postgres DB credentials primarily).
  • ./listmonk --install to setup the DB.
  • Run ./listmonk and visit http://localhost:9000.
  • Since there is no user auth yet, it's best to put listmonk behind a proxy like Nginx and setup basicauth on all endpoints except for the few endpoints that need to be public. Here is a sample nginx config for production use.

Running on Docker

You can pull the official Docker Image from Docker Hub.

You can checkout the docker-compose.yml to get an idea of how to run listmonk with PostgreSQL together using Docker.

  • docker-compose up -d app db to run all the services together.
  • docker-compose run --rm app ./listmonk --install to setup the DB.
  • Visit http://localhost:9000.

Alternatively, to run a demo of listmonk, you can quickly spin up a container docker-compose up -d demo-db demo-app. NOTE: This doesn't persist Postgres data after you stop and remove the container, this setup is intended only for demo. DO NOT use the demo setup in production.

Help and docs

Help and documentation (work in progress).

Current features

  • Admin dashboard
  • Multiple public and private lists
  • Fast bulk subscriber import
  • Custom subscriber attributes
  • Subscriber querying and segmentation with ad-hoc SQL
  • Rich Go templates and WYSIWYG editor
  • Media gallery
  • Multi-threaded multi-SMTP e-mail queues for fast campaign delivery
  • HTTP/JSON APIs for everything
  • Clicks and view tracking
  • and more ...

Todo

  • DB migrations
  • Bounce tracking
  • User auth, management, permissions
  • Ability to write raw campaign logs to a target
  • Analytics views and reports
  • Better widgets on dashboard
  • Tests!

Developers

listmonk is free, open source software licensed under AGPLv3. There are several essential features such as user auth/management and bounce tracking that are currently missing. Contributions are welcome.

The backend is written in Go and the frontend is in React with Ant Design for UI. See developer setup to get started.

License

listmonk is licensed under the AGPL v3 license.