High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
Find a file
2024-10-20 23:50:06 +05:30
.github
cmd Fix and refactor subscriber batch fetching in campaign processing. 2024-10-13 17:03:59 +05:30
dev
docs Add docs for v4.x.x multi-user upgrade changes. 2024-10-13 16:59:52 +05:30
frontend Show OIDC URL warning only when enabled on the UI. 2024-10-20 23:50:06 +05:30
i18n Update it.json (#2085) 2024-10-14 22:17:53 +05:30
internal Fix broken status in subscriber export query. 2024-10-20 23:50:06 +05:30
models Add missing auth permissions file. 2024-10-13 17:03:59 +05:30
scripts
static Update OIDC auth URL in login form. 2024-10-13 16:59:52 +05:30
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample Remove admin user/password from sample config generation. 2024-10-13 16:59:52 +05:30
CONTRIBUTING.md
docker-compose.yml Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
docker-entrypoint.sh
Dockerfile
go.mod Upgrade simplesessions to v3. 2024-10-13 16:59:51 +05:30
go.sum Upgrade simplesessions to v3. 2024-10-13 16:59:51 +05:30
install-demo.sh
install-prod.sh Slightly improve docker-compose feedback (#2054) 2024-10-04 10:28:22 +05:30
LICENSE
listmonk-simple.service
listmonk@.service
Makefile Refactor 'super' user type to a pre-defined super admin role. 2024-10-13 16:59:52 +05:30
permissions.json Add list permission check to subscriber calls. 2024-10-13 17:03:55 +05:30
project.inlang.json
queries.sql Fix and refactor subscriber batch fetching in campaign processing. 2024-10-13 17:03:59 +05:30
README.md
schema.sql Fix and refactor subscriber batch fetching in campaign processing. 2024-10-13 17:03:59 +05:30
VERSION

listmonk-logo

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 (⩾ 12) database as its data store.

listmonk-dashboard

Visit listmonk.app for more info. Check out the live demo.

Installation

Docker

The latest image is available on DockerHub at listmonk/listmonk:latest. Use the sample docker-compose.yml to run manually or use the helper script.

Demo

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

DO NOT use this demo setup in production.

Production

mkdir listmonk && cd listmonk
bash -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-prod.sh)"

Visit http://localhost:9000.

NOTE: Always examine the contents of shell scripts before executing them.

See installation 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.

See installation docs.


Developers

listmonk is 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.