Go to file
Gokhan c30068d3ea
Add kubernetes helm installation instructions to docs (#1847)
2024-04-28 09:03:34 +05:30
.github Update general-question.md 2023-12-22 19:16:49 +05:30
cmd chore: fix function name in comment (#1836) 2024-04-22 18:43:23 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
docs Add kubernetes helm installation instructions to docs (#1847) 2024-04-28 09:03:34 +05:30
frontend Fix incorrect filter query in bounces UI. Closes #1820. 2024-04-13 08:52:25 +05:30
i18n Update pl.json (#1800) 2024-03-28 11:07:35 +05:30
internal 👌 IMPROVE: make RootURL available in email templates (#1812) 2024-04-04 22:57:52 +05:30
models chore: remove repetitive words (#1778) 2024-03-11 13:33:50 +05:30
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static Simplify default e-mail template. 2024-02-04 11:37:25 +05:30
.dockerignore feat: Add blobstore package 2019-10-31 11:25:31 +05:30
.gitattributes Added end of line config for git 2022-01-26 09:50:06 +01:00
.gitignore feat: Add separate config for demo setup, tweak docs 2020-07-08 22:38:31 +05:30
.goreleaser.yml Docker Multi Arch (esp. ARM) builds: Improving Build File (#1451) 2023-09-07 22:23:17 +05:30
CONTRIBUTING.md Fix link to the docs repo. 2023-03-26 11:17:15 +05:30
Dockerfile feat: Add timezone config in app container 2021-12-29 11:42:04 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
Makefile Update Go deps. 2024-01-27 20:55:50 +05:30
README.md fix: easy install docker script for macOS (#1742) 2024-02-21 13:11:38 +05:30
VERSION Add a VERSION file for git-archive export 2021-08-14 13:41:19 +05:30
config-demo.toml Don't indent TOML keys deeper than their sections 2021-05-06 18:28:04 +03:00
config.toml.sample Add optional `params` in DB config to accept arbitrary Postgres params. Closes #1016. 2022-12-25 16:28:19 +05:30
docker-compose.yml feat: docker compose use alpine for postgres (#1603) 2023-11-24 14:48:57 +05:30
go.mod Bump golang.org/x/net from 0.20.0 to 0.23.0 (#1833) 2024-04-22 14:02:47 +05:30
go.sum Bump golang.org/x/net from 0.20.0 to 0.23.0 (#1833) 2024-04-22 14:02:47 +05:30
install-demo.sh fix: easy install docker script for macOS (#1742) 2024-02-21 13:11:38 +05:30
install-prod.sh fix: easy install docker script for macOS (#1742) 2024-02-21 13:11:38 +05:30
listmonk-simple.service Update listmonk-simple.service - add optional log file (#1640) 2024-01-09 23:41:14 +05:30
listmonk@.service Enable extra system calls in systemd service (#1309) 2023-07-12 19:42:54 +05:30
project.inlang.json fix: update inlang settings (#1529) 2023-09-20 14:19:08 +05:30
queries.sql fix: query campaign does not search numbers (#1758) 2024-03-08 09:48:34 +05:30
schema.sql Merge branch 'query-performance' 2024-01-27 15:56:09 +05:30

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 (⩾ 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 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.