beenull/listmonk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.
1152 commits 4 branches 29 tags 19 MiB
Go 40.7%
JavaScript 27.2%
Vue 26%
HTML 1.9%
SCSS 1.8%
Other 2.3%
Find a file
Marcin Kunert ad53632be4
Expanded docs about PUT /api/subscribers/:id (#1269) 
I've expanded the docs a bit, related to #995
2023-04-02 20:40:38 +05:30
.github Fix gh-pages workflow script to run on push to master. 2023-03-26 11:54:46 +05:30
cmd Add functions to notification templates (#1263) 2023-03-26 12:00:35 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
docs Expanded docs about PUT /api/subscribers/:id (#1269) 2023-04-02 20:40:38 +05:30
frontend Include CAPTCHA in HTML form generation. 2023-03-25 11:21:06 +05:30
i18n Update es.json (#1258) 2023-03-25 11:31:32 +05:30
internal Fix broken SES bounce type check. 2023-04-02 20:39:01 +05:30
models Add support for file attachments in the transactional (tx) API. (#1243) 2023-03-19 15:50:44 +05:30
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static Fix public preference manage page's list style. 2023-02-26 12:36:06 +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 add support for arm binaries (#1249) 2023-03-21 18:01:30 +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
CONTRIBUTING.md Fix link to the docs repo. 2023-03-26 11:17:15 +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 Upgrade Go package deps. 2023-03-19 22:58:38 +05:30
go.sum Upgrade Go package deps. 2023-03-19 22:58:38 +05:30
inlang.config.js Integrate inlang for easy i18n translations (#1189) 2023-03-19 14:03:30 +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 Refactor and add new build routines 2019-07-09 15:57:04 +05:30
listmonk@.service add systemd service unit 2021-07-07 14:15:16 +02:00
Makefile Use --idempotent and --yes flags when bootstrapping the dev db 2022-01-19 09:29:47 -05:00
queries.sql Fix discrepency in SQL query/export queries. Closes #1241. 2023-03-19 12:53:05 +05:30
README.md Remove Heroku buttons (as it has blocked listmonk without explanation). 2022-03-07 18:25:20 +05:30
schema.sql Add hCaptcha.com support to public subscription form. (#1152) 2023-01-23 21:50:10 +05:30
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.

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.