beenull/listmonk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
listmonk/README.md
mr-karan 3ed39a4f56 feat: Add docker instructions
2019-07-12 07:52:05 +05:30

2.9 KiB
Raw Blame History

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 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 --config /etc/listmonk/config.toml to setup the DB.
  • Visit http://localhost:9000.

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.