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.
824 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 9e9ea0ef15 Refactor automatic camel casing of API response fields. 
- Remove `humps` lib dependency with a new util function.
- Replace hacky way of excluding certain fields in responses with
  a proper key filtering mechanism.
2022-01-04 22:17:05 +05:30
.github
cmd Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +05:30
dev
frontend Refactor automatic camel casing of API response fields. 2022-01-04 22:17:05 +05:30
i18n Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +05:30
internal Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +05:30
models
scripts
static
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample
CONTRIBUTING.md
docker-compose.yml
Dockerfile
go.mod Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +05:30
go.sum Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +05:30
install-demo.sh
install-prod.sh
LICENSE
listmonk@.service
Makefile
queries.sql
README.md
schema.sql Add support for direct SSL/TLS (non-STARTTLS) SMTP connections. 2022-01-03 19:28:36 +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.