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.
295 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 97583fe4b4 Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 
- antd+react was resulting in extremely clunky and unreadable
  spaghetti frontend code (primarily due to how antd is).
- Buefy is lighter by an order of magnitude, has excellent
  responsive views (especially tables) and usability.
- Vue's templating produces far more readable template code.
2020-07-04 00:12:14 +05:30
frontend Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
internal Add support for custom e-mail headers per SMTP server 2020-05-31 21:16:56 +05:30
models Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
static Add support for hosted messages and {{ MessageURL }} tpl tag. 2020-04-26 15:51:43 +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 blobstore package 2019-10-31 11:25:31 +05:30
.goreleaser.yml fix: Path for windows build in goreleaser 2019-07-12 15:44:44 +05:30
admin.go Refactor and cleanup initialization. 2020-03-08 00:06:48 +05:30
campaigns.go Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
config.toml.sample Add support for custom e-mail headers per SMTP server 2020-05-31 21:16:56 +05:30
docker-compose.yml feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
Dockerfile feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
go.mod Add TLS to SMTP config 2020-05-17 21:07:48 +05:30
go.sum Integrate new SMTP pool lib 2020-05-16 23:25:37 +05:30
handlers.go Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
import.go Move internal packages to 'internal' dir 2020-03-08 00:17:54 +05:30
init.go Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
install.go Add support for loading custom static files with --static-dir 2020-03-14 21:07:14 +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
lists.go Fix incorrect param read bug in list deletion handler 2020-05-23 12:03:04 +05:30
main.go Add support for loading custom static files with --static-dir 2020-03-14 21:07:14 +05:30
Makefile Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
manager_db.go Refactor get-campaign to accept uuid + get body 2020-04-26 15:51:26 +05:30
media.go Minor formatting fixes 2020-03-08 10:54:10 +05:30
notifications.go Add support for pushing non-campaign message with workers. 2020-03-08 12:27:41 +05:30
public.go Fix incorrect config check in subscriber data wipe 2020-06-05 09:25:45 +05:30
queries.go Add support for sending 'opt-in' campaigns. 2020-02-09 11:36:15 +05:30
queries.sql Rewrite frontend with Vue+Buevy and ditch React+Ant Design. 2020-07-04 00:12:14 +05:30
README.md Add note about Heroku deploy button 2020-04-02 10:23:01 +00:00
schema.sql Add support for sending 'opt-in' campaigns. 2020-02-09 11:36:15 +05:30
stats.sql Add support for campaign view tracking with {{ TrackView }} pixel tag 2018-11-02 13:20:32 +05:30
subscribers.go Fix incorrect wrapping of subscriber handler 2020-06-07 16:28:33 +05:30
templates.go Fix template preview sending invalid view requests 2020-03-08 15:10:51 +05:30
TODO.md Remove completed items 2020-05-25 11:55:02 +05:30
utils.go Remove 'govalidator' package dependecy 2020-03-08 13:03:38 +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.

Configuration and customization

See the configuration Wiki page.

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 (also see configuring with environment variables).

  • 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.

Other deployments

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 configruation variables.

Help and docs

Help and documentation (work in progress).

Current features

  • Admin dashboard
  • Public, private, single and double optin lists (with optin campaigns)
  • Fast bulk subscriber import
  • Custom subscriber attributes
  • Subscriber querying and segmentation with ad-hoc SQL expressions
  • Subscriber data wipe / export privacy features
  • Rich programmable Go HTML templates and WYSIWYG editor
  • Media gallery (disk and S3 storage)
  • 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.