hangar-tech
/
listmonk
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
427 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 afef994e6d Fix incorrect make command 2021-01-24 13:07:42 +05:30
cmd Fix default campaign template not being setup on first install. 2021-01-24 12:49:52 +05:30
frontend Fix incorrect label on skip-TLS setting on UI 2021-01-24 12:26:44 +05:30
i18n Add support for rate limiting messages with a sliding window. 2021-01-24 12:19:26 +05:30
internal Fix default campaign template not being setup on first install. 2021-01-24 12:49:52 +05:30
models Add subscriber export feature 2021-01-23 18:23:29 +05:30
static Refactor i18n name and fix the L() function in public HTML templates 2021-01-23 19:34:30 +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 Add (Open/Net/Free)BSD to cross-platform release builds. 2020-10-18 22:48:00 +05:30
Dockerfile 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 Fix incorrect make command 2021-01-24 13:07:42 +05:30
README.md Remove alpha warning 2020-11-11 18:45:41 +05:30
TODO.md Remove completed items 2020-05-25 11:55:02 +05:30
config-demo.toml feat: Set default values for DB connection parameters 2020-11-17 14:34:35 +05:30
config.toml.sample feat: Set default values for DB connection parameters 2020-11-17 14:34:35 +05:30
docker-compose.yml feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
go.mod WIP: Add i18n support 2021-01-17 20:59:01 +05:30
go.sum Update smtppool lib adding support for Unicode in e-mail IDs 2020-10-17 23:35:03 +05:30
queries.sql Add subscriber export feature 2021-01-23 18:23:29 +05:30
schema.sql Add support for rate limiting messages with a sliding window. 2021-01-24 12:19:26 +05:30
stats.sql Add support for campaign view tracking with {{ TrackView }} pixel tag 2018-11-02 13:20:32 +05:30

README.md

listmonk

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-dashboard Visit listmonk.app

Installation

Docker

The latest image is available on DockerHub at listmonk/listmonk:latest. Use the sample docker-compose.yml to run listmonk and Postgres DB with docker-compose as follows:

Demo

docker-compose up -d demo-db demo-app

The demo does not persist Postgres after the containers are removed. DO NOT use this demo setup in production.

Production

  • docker-compose up db to run the Postgres DB.
  • docker-compose run --rm app ./listmonk --install to setup the DB (or --upgrade to upgrade an existing DB)
  • Run docker-compose up app and visit http://localhost:9000.

More information on docs.

Binary

  • Download the latest release and extract the listmonk binary.
  • ./listmonk --new-config to generate config.toml. Then, edit the file.
  • ./listmonk --install to setup the Postgres DB (or --upgrade to upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).
  • Run ./listmonk and visit http://localhost:9000.

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

Developers

listmonk is a free and open source software licensed under AGPLv3. If you are interested in contributing, refer to the developer setup. The backend is written in Go and the frontend is Vue with Buefy for UI.

License

listmonk is licensed under the AGPL v3 license.