knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-02-25 06:45:42 +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.
1070 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 4f2f419ae2 Include send_at when cloning campaigns on the UI. Closes #1027.
2022-11-19 17:01:07 +05:30
.github
cmd
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
frontend
i18n Add public archive on/off toggle to settings. 2022-11-10 23:30:53 +05:30
internal
models
scripts
static
.dockerignore
.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
config-demo.toml
config.toml.sample
CONTRIBUTING.md
docker-compose.yml
Dockerfile
go.mod
go.sum
install-demo.sh
install-prod.sh
LICENSE
listmonk@.service add systemd service unit 2021-07-07 14:15:16 +02:00
Makefile
queries.sql
README.md
schema.sql
stats.sql
TODO.md Remove completed items 2020-05-25 11:55:02 +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.