hangar-tech
/
listmonk
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
164 Commits 2 Branches 21 Tags 10 MiB
Go 47.5%
Vue 32.8%
JavaScript 9.9%
CSS 4%
HTML 2.5%
Other 3.3%
Go to file
karan 0a50cd69e0 feat: Add docker image link to README 2019-07-12 17:57:32 +05:30
email-templates Add embedding of static assets for standalone dist binary 2019-01-03 16:48:47 +05:30
frontend Add missing help link to subscriber modal 2019-07-12 15:09:58 +05:30
manager Refactor TrackLink template function to accept backticks 2018-12-19 12:28:52 +05:30
messenger Replace viper with koanf 2019-06-26 16:53:23 +05:30
models Add pagination to the lists page 2019-05-14 16:41:05 +05:30
public Add embedding of static assets for standalone dist binary 2019-01-03 16:48:47 +05:30
subimporter Update list date on import before notif and run notif as a goroutine 2019-05-14 22:18:18 +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 feat: Add docker image link to README 2019-07-12 17:57:32 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
Makefile Refactor and add new build routines 2019-07-09 15:57:04 +05:30
README.md feat: Add docker image link to README 2019-07-12 17:57:32 +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 Optimize campaign and subscriber queries 2019-04-01 17:07:24 +05:30
config.toml.sample feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
docker-compose.yml feat: Add docker demo setup 2019-07-12 14:03:54 +05:30
go.mod Update dependencies 2019-07-05 14:18:50 +05:30
go.sum Update dependencies 2019-07-05 14:18:50 +05:30
handlers.go Remove stub user features and handlers. 2019-06-26 16:22:47 +05:30
import.go Refactor and fix importer state bugs 2019-04-03 14:08:31 +05:30
install.go Refactor and add new build routines 2019-07-09 15:57:04 +05:30
lists.go Add pagination to the lists page 2019-05-14 16:41:05 +05:30
main.go Refactor and add new build routines 2019-07-09 15:57:04 +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 admin e-mail notifications. 2018-11-28 13:29:57 +05:30
public.go Add embedding of static assets for standalone dist binary 2019-01-03 16:48:47 +05:30
queries.go Remove stub user features and handlers. 2019-06-26 16:22:47 +05:30
queries.sql Fix import and campaign page and integrate new paginated lists API 2019-05-14 22:06:14 +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 basic sanitisation to subscriber query expressions 2019-07-04 17:40:55 +05:30
templates.go Remove redundant error wrapper 2018-12-26 15:38:08 +05:30
utils.go Add bulk subscriber querying, segmentation, and management features 2018-12-18 10:54:55 +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 and extract the listmonk binary somewhere.
  • 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.
  • 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 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
  • Privacy features for subscribers (Download and wipe all tracking data)
  • Ability to write raw campaign logs to a target
  • Analytics views and reports
  • Make Ant design UI components responsive
  • 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.