knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-01-09 07:48:17 +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.
837 commits 6 branches 33 tags 22 MiB
Go 43.5%
Vue 27%
JavaScript 24.1%
HTML 1.8%
SCSS 1.7%
Other 1.8%
Find a file
Kailash Nadh b0787f7331
Merge pull request #649 from joeirimpan/fix/msgr-persist 
fix(frontend): Persist messenger selection
2022-01-05 11:52:36 +05:30
.github Remove redundant GitHub issue template. 2021-10-10 17:46:05 +05:30
cmd Add support for per-campaign custom headers. 2022-01-04 22:27:40 +05:30
dev feat: Add dev docker setup 2021-12-01 23:17:14 +05:30
frontend fix(frontend): Persist messenger selection 2022-01-05 11:41:29 +05:30
i18n Add support for per-campaign custom headers. 2022-01-04 22:27:40 +05:30
internal Add support for additional POP3 mail charsets. Closes #644. 2022-01-04 22:46:42 +05:30
models Merge branch 'master' of github.com:knadh/listmonk 2022-01-04 22:33:58 +05:30
scripts
static Add support for custom CSS/JS in settings for admin and public pages. 2021-12-18 15:38:42 +05:30
.dockerignore
.gitattributes Add a VERSION file for git-archive export 2021-08-14 13:41:19 +05:30
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample
CONTRIBUTING.md Fix typo 2021-10-30 16:50:41 +05:30
docker-compose.yml feat: Add timezone config in app container 2021-12-29 11:42:04 +05:30
Dockerfile feat: Add timezone config in app container 2021-12-29 11:42:04 +05:30
go.mod Merge branch 'master' of github.com:knadh/listmonk 2022-01-04 22:33:58 +05:30
go.sum Tidy go.mod 2022-01-04 22:34:51 +05:30
install-demo.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
install-prod.sh fix(install-prod.sh): Make tr work with macOS 2021-12-15 14:44:00 +05:30
LICENSE
listmonk@.service
Makefile Fix typo in Makefile. 2021-12-18 13:14:14 +05:30
queries.sql Add support for per-campaign custom headers. 2022-01-04 22:27:40 +05:30
README.md Add a note on Postgres min version. 2021-11-09 22:43:44 +05:30
schema.sql Add support for per-campaign custom headers. 2022-01-04 22:27:40 +05:30
stats.sql
TODO.md
VERSION Add a VERSION file for git-archive export 2021-08-14 13:41:19 +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 (⩾ 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.