knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-11-10 09:02:36 +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.
1233 commits 6 branches 32 tags 23 MiB
Go 43.2%
Vue 27.1%
JavaScript 24.3%
HTML 1.8%
SCSS 1.7%
Other 1.8%
Find a file
Kailash Nadh 83c88d73d7 Escape search query in list search. Closes #1471.
2023-08-27 14:35:42 +05:30
.github Fix GH actions write permission. 2023-08-11 00:02:43 +05:30
cmd Make public subscription API follow the 'enable public' setting. 2023-08-15 21:05:29 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
docs added "tutorials" section and other minor edits (#1444) 2023-08-27 13:34:22 +05:30
frontend Escape search query in list search. Closes #1471. 2023-08-27 14:35:42 +05:30
i18n Fix broken dummy password warning on SMTP test UI. Closes #1450. 2023-08-15 20:57:58 +05:30
internal Add check for SES 'invalid domain' transient bounces. Closes #1463. 2023-08-20 09:48:21 +05:30
models Add new privacy option 'Record opt-in IP' to record IP address of optin confirmation. 2023-07-26 23:00:32 +05:30
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static Add classes to public forms to make them scriptable. 2023-08-07 23:57:29 +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 feat: add multiarch docker build support (#1344) 2023-07-18 11:16:25 +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 go: bump to 1.20 (#1479) 2023-08-27 13:24:47 +05:30
go.sum go: bump to 1.20 (#1479) 2023-08-27 13:24:47 +05:30
inlang.config.js Update inlang.config.js (#1359) 2023-06-03 18:22:13 +05:30
install-demo.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
install-prod.sh Modify sed flag based on OS. Closes #1474. 2023-08-27 13:32:57 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
listmonk@.service Enable extra system calls in systemd service (#1309) 2023-07-12 19:42:54 +05:30
Makefile Use --idempotent and --yes flags when bootstrapping the dev db 2022-01-19 09:29:47 -05:00
queries.sql Fix hardcoded DB name in 'about' SQL query. Closes #1477. 2023-08-27 13:20:41 +05:30
README.md Update Postgres version in doc strings. 2023-07-27 23:45:39 +05:30
schema.sql Add new privacy option 'Record opt-in IP' to record IP address of optin confirmation. 2023-07-26 23:00:32 +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 (⩾ 12) 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.