hangar-tech
/
listmonk
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
351 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
Kailash Nadh 5fb7c6cfb0 Add support for automatic, idempotent DB migrations 
- On boot, the app now checks if the DB version matches its
  expected version and refuses to start if there are pending
  migrations to be run.
- The new `--upgrade` flag runs data migrations from the last
  recorded migration (in the settings table) to the latest one
  in the binary.
- Migrations are DB/arbitrary logic functions in .go files in
  internal/migrations.
- All migration functions are idempotent.
 		2020-08-03 19:02:23 +05:30
frontend Upgrade JS dependencies (security fixes) 2020-08-01 20:28:39 +05:30
internal Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
models Refactor `blacklist` to `blocklist` 2020-08-01 16:45:29 +05:30
static Add support for `List-Unsubscribe` header. 2020-08-01 17:54:51 +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 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
INSTALL.md feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
Makefile Add settings UI and "hot reload" support to the app. 2020-07-21 00:23:57 +05:30
README.md Polish UI elements and fix styling issues. 2020-07-26 20:35:06 +05:30
TODO.md Remove completed items 2020-05-25 11:55:02 +05:30
admin.go Add settings UI and "hot reload" support to the app. 2020-07-21 00:23:57 +05:30
campaigns.go Add campaign search UI. 2020-08-01 19:46:47 +05:30
config-demo.toml Refactor `blacklist` to `blocklist` 2020-08-01 16:45:29 +05:30
config.toml.sample Add settings UI and "hot reload" support to the app. 2020-07-21 00:23:57 +05:30
docker-compose.yml feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
go.mod Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
go.sum Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
handlers.go Refactor pagination constants 2020-08-01 18:57:33 +05:30
import.go Refactor `blacklist` to `blocklist` 2020-08-01 16:45:29 +05:30
init.go Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
install.go Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
lists.go Refactor pagination constants 2020-08-01 18:57:33 +05:30
main.go Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
manager_db.go Refactor `get-campaign` to accept uuid + get body 2020-04-26 15:51:26 +05:30
media.go Refactor and fix media uploads. 2020-07-05 17:35:05 +05:30
notifications.go Add support for pushing non-campaign message with workers. 2020-03-08 12:27:41 +05:30
public.go Add support for `List-Unsubscribe` header. 2020-08-01 17:54:51 +05:30
queries.go Refactor `blacklist` to `blocklist` 2020-08-01 16:45:29 +05:30
queries.sql Add campaign search UI. 2020-08-01 19:46:47 +05:30
schema.sql Add support for automatic, idempotent DB migrations 2020-08-03 19:02:23 +05:30
settings.go Add support for `List-Unsubscribe` header. 2020-08-01 17:54:51 +05:30
stats.sql Add support for campaign view tracking with {{ TrackView }} pixel tag 2018-11-02 13:20:32 +05:30
subscribers.go Refactor pagination constants 2020-08-01 18:57:33 +05:30
templates.go Fix template creation API returning incorrect response 2020-08-01 13:21:28 +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 the DB configuration.
  • ./listmonk --install to setup the DB.
  • Run ./listmonk and visit http://localhost:9000.
  • Visit the Settings page to configure your instance.
  • 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). Please visit INSTALL.md for detailed instructions on how to setup Listmonk with Docker.

Alternatively, to run a demo of listmonk, you can quickly spin up a local setup with:

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.