listmonk README

The project's README from github.com/knadh/listmonk. As one markdown file: README.md.

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 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. Download and use the sample docker-compose.yml.

# Download the compose file to the current directory.
curl -LO https://github.com/knadh/listmonk/raw/master/docker-compose.yml

# Run the services in the background.
docker compose up -d

Visit http://localhost:9000

See installation docs


Binary

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.

listmonk (knadh/listmonk)

Searching Database…

23.8K ·GitHub
What is this?listmonk is a self-hosted newsletter and mailing list manager that handles subscriber lists, campaigns, and transactional emails, all packed into a single binary with a modern web dashboard.
Is this a library or a standalone app?It is a standalone self-hosted application: a Go backend compiled into one binary plus a Vue-based web dashboard, backed by a PostgreSQL database.
How do I get it running?Easiest way is Docker: pull listmonk/listmonk:latest and use the sample docker-compose.yml. Alternatively, download the release binary, run './listmonk --new-config' to generate config.toml, then './listmonk --install' to set up the Postgres DB, and finally run './listmonk'.
Do I need anything besides the binary itself?You need a PostgreSQL database for data storage; everything else (app logic, UI assets) is bundled into the single binary.
Are upgrades to an existing installation safe to run?Yes, the '--upgrade' flag applied to an existing database is idempotent, so running it multiple times causes no side effects.
What's the tech stack behind the dashboard?The backend is written in Go, and the frontend uses Vue with the Buefy UI component library.
Can I try it before installing?Yes, there's a live demo linked from the project's website (listmonk.app) so you can explore the dashboard before setting it up yourself.
Does it support SMS or just email campaigns?Beyond email newsletters and transactional emails, listmonk also supports an SMS gateway integration for sending campaigns via SMS.
Creator
knadh
Size
51.8 MB
Stars
23.8K
Age
7y
Commits · 90 Days