knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-01-10 00:08:15 +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.
752 commits 6 branches 33 tags 22 MiB
Go 43.5%
Vue 27%
JavaScript 24.1%
HTML 1.8%
SCSS 1.7%
Other 1.8%
Find a file
Kailash Nadh 443ba184c3
Merge pull request #491 from citrus-it/makedep 
pack-bin is missing dependency on build-frontend
2021-09-29 19:15:23 +05:30
.github Fix build step in GitHub actions. 2021-09-27 23:26:56 +05:30
cmd Add a landing login page and a logout option. 2021-09-26 23:42:57 +05:30
frontend Fix status tag flashing on campaign edit UI load. 2021-09-27 23:20:36 +05:30
i18n Replace TinyMCE source editor with Flask HTML editor. 2021-09-27 23:11:19 +05:30
internal Remove obsolete bounce routines from manager package. 2021-09-26 18:57:25 +05:30
models Introduce @TrackLink shorthand for generating tracking links. 2021-09-26 16:03:05 +05:30
scripts
static Add missing home template. 2021-09-27 21:17:23 +05:30
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample
docker-compose.yml Bump Postgres version to 13 in example Docker setup. 2021-09-27 20:38:24 +05:30
Dockerfile
go.mod Add custom S3 backend support (eg: Minio) to media uploads 2021-08-15 16:09:00 +05:30
go.sum Add custom S3 backend support (eg: Minio) to media uploads 2021-08-15 16:09:00 +05:30
install-demo.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
install-prod.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
LICENSE
listmonk@.service
Makefile Merge pull request #491 from citrus-it/makedep 2021-09-29 19:15:23 +05:30
queries.sql Fix broken Cypress tests. 2021-09-25 18:05:15 +05:30
README.md Fix typo 2021-09-28 18:52:34 +05:30
schema.sql Add support for blocklisting e-mail domains. 2021-09-25 15:39:09 +05:30
stats.sql
TODO.md
VERSION

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. Use the sample docker-compose.yml to run manually or use the helper script.

Demo

mkdir listmonk-demo && cd listmonk-demo
sh -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
sh -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.

Heroku

Deploy

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.