knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-11-10 09:02:36 +08:00
Code Issues Projects Releases Packages Wiki Activity
High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
477 commits 6 branches 32 tags 23 MiB
Go 43.2%
Vue 27.1%
JavaScript 24.3%
HTML 1.8%
SCSS 1.7%
Other 1.8%
Find a file
TomBoss b4fea57543
Merge pull request #1 from knadh/master 
update
2021-02-15 19:06:05 +01:00
cmd Fix incorrect 'get subscriber' calls 2021-02-15 18:27:14 +05:30
frontend Allow editing of unsubscribed lists on the UI 2021-02-13 18:05:31 +05:30
i18n Format i18n/fr JSON file 2021-02-13 18:11:10 +05:30
internal Adding Safe templating function for keeping HTML comment 2021-02-15 13:33:47 +01:00
models Add support for alternate plaintext body for e-mails. 2021-01-30 18:49:47 +05:30
static Fix broken opt-in campaign template 2021-02-13 13:28:39 +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 chore: Pass the binary path correctly to make 2021-02-01 16:18:09 +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
Dockerfile feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
go.mod Tidy go.mod 2021-02-13 12:42:38 +05:30
go.sum Tidy go.mod 2021-02-13 12:42:38 +05:30
install-demo.sh feat: Add shell script for demo setup 2021-01-21 21:53:49 +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
queries.sql Fix the optin-in, form re-subscribe behaviour. 2021-02-13 17:55:10 +05:30
README.md feat: Add shell script for demo setup 2021-01-21 21:53:49 +05:30
schema.sql Add a new public page for end users to subscribe to public lists. 2021-01-31 16:19:39 +05:30
stats.sql Add support for campaign view tracking with {{ TrackView }} pixel tag 2018-11-02 13:20:32 +05:30
TODO.md Remove completed items 2020-05-25 11:55:02 +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

mkdir listmonk-demo
sh -c "$(curl -sSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)"

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.