knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-03-04 02:05:31 +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.
872 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 8fb459dc48 Fix custom DB type scan failing when nil.
2022-02-05 18:48:41 +05:30
.github
cmd Support status in bulk subscriber list update API. Closes #604. 2022-02-05 00:03:28 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
frontend Fix campaign start throwing error when disabling schedule on the UI. 2022-02-04 22:43:42 +05:30
i18n Merge branch 'master' of github.com:knadh/listmonk 2022-02-01 23:42:36 +05:30
internal Add support for custom public S3 URLs. Closes #505. 2022-01-15 21:20:32 +05:30
models Fix custom DB type scan failing when nil. 2022-02-05 18:48:41 +05:30
scripts
static
.dockerignore
.gitattributes Added end of line config for git 2022-01-26 09:50:06 +01:00
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample
CONTRIBUTING.md
docker-compose.yml
Dockerfile
go.mod Fix media upload S3 IAM init blocking outside non-AWS environments. 2022-01-15 20:45:17 +05:30
go.sum Fix media upload S3 IAM init blocking outside non-AWS environments. 2022-01-15 20:45:17 +05:30
install-demo.sh
install-prod.sh
LICENSE
listmonk@.service
Makefile Use --idempotent and --yes flags when bootstrapping the dev db 2022-01-19 09:29:47 -05:00
queries.sql Support status in bulk subscriber list update API. Closes #604. 2022-02-05 00:03:28 +05:30
README.md Change Heroku button repo. 2022-01-21 09:25:23 +05:30
schema.sql Add support for custom public S3 URLs. Closes #505. 2022-01-15 21:20:32 +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 (⩾ 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.

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.