knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-02-25 14:55:18 +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.
1164 commits 7 branches 33 tags 23 MiB
Go 43.5%
Vue 27.1%
JavaScript 24%
HTML 1.8%
SCSS 1.7%
Other 1.8%
Find a file
Chinmay Pai 8c46b758ce
build: push docker image to ghcr.io (#1237) 
with the new recent changes in dockerhub[1] we should
start pushing images to ghcr, and eventually phase out
the existing dockerhub setup.

[1]: https://blog.alexellis.io/docker-is-deleting-open-source-images/

Signed-off-by: Chinmay D. Pai <chinmay.pai@zerodha.com>
2023-04-11 21:42:41 +05:30
.github build: push docker image to ghcr.io (#1237) 2023-04-11 21:42:41 +05:30
cmd Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
dev
docs
frontend Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
i18n Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
internal Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
models Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
scripts
static
.dockerignore feat: Add blobstore package 2019-10-31 11:25:31 +05:30
.gitattributes
.gitignore
.goreleaser.yml build: push docker image to ghcr.io (#1237) 2023-04-11 21:42:41 +05:30
config-demo.toml
config.toml.sample
CONTRIBUTING.md
docker-compose.yml
Dockerfile
go.mod Upgrade koanf to v2. 2023-04-10 12:45:25 +05:30
go.sum Upgrade koanf to v2. 2023-04-10 12:45:25 +05:30
inlang.config.js
install-demo.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
install-prod.sh
LICENSE
listmonk@.service
Makefile
queries.sql Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
README.md Add white background to logo in README for dark mode. Closes #1268. 2023-04-11 12:51:24 +05:30
schema.sql Add support for variable bounce processing actions. 2023-04-11 11:33:40 +05:30
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 (⩾ v9.4) 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.

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.