knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-03-02 17:23:07 +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.
936 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
Kailash Nadh c898ec2b21
Merge pull request from nathanaelhoun/patch-1 
Updated French translations
2022-04-29 12:19:24 +05:30
.github
cmd Fix typos 2022-03-20 11:17:29 -07:00
dev
frontend Bump minimist from 1.2.5 to 1.2.6 in /frontend 2022-03-27 01:48:03 +00:00
i18n Updated some French translations 2022-04-28 18:57:24 +02:00
internal Merge pull request from yatish27/fix_typos_in_comments 2022-04-03 11:39:07 +05:30
models Fix POP mail parsing in multipart bounce e-mails. 2022-04-03 11:37:11 +05:30
scripts
static
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample
CONTRIBUTING.md
docker-compose.yml
Dockerfile
go.mod feat: bump simples3 for digitalocean support 2022-02-22 11:30:56 +05:30
go.sum feat: bump simples3 for digitalocean support 2022-02-22 11:30:56 +05:30
install-demo.sh
install-prod.sh
LICENSE
listmonk@.service
Makefile
queries.sql Add ability to export select subscriber ids. 2022-03-19 13:44:23 +05:30
README.md Remove Heroku buttons (as it has blocked listmonk without explanation). 2022-03-07 18:25:20 +05:30
schema.sql Use empty logo_url as default 2022-02-16 12:09:38 +04:00
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 (⩾ 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.