Skip to content
forked from knadh/listmonk

High performance, self-hosted newsletter and mailing list manager with a modern dashboard. Single binary app.

License

Notifications You must be signed in to change notification settings

lborgav/listmonk

This branch is 1025 commits behind knadh/listmonk:master.

Folders and files

NameName
Last commit message
Last commit date
May 17, 2021
May 23, 2021
May 28, 2021
May 27, 2021
May 21, 2021
May 9, 2021
Apr 14, 2021
Apr 21, 2021
Oct 31, 2019
Jul 15, 2019
Jul 8, 2020
Mar 19, 2021
Apr 19, 2021
Jul 9, 2019
Apr 11, 2021
Jan 21, 2021
May 25, 2020
May 6, 2021
May 7, 2021
Apr 11, 2021
May 21, 2021
May 21, 2021
Jan 21, 2021
Apr 17, 2021
May 16, 2021
Nov 2, 2018

Repository files navigation

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.

About

High performance, self-hosted newsletter and mailing list manager with a modern dashboard. Single binary app.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 48.9%
  • Vue 33.4%
  • JavaScript 10.1%
  • SCSS 2.8%
  • HTML 2.6%
  • CSS 0.9%
  • Other 1.3%