knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-03-01 00:35:28 +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.
1455 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 906e0f57b6 Refactor handler groups and add mising auth features like logout.
2024-10-13 16:59:51 +05:30
.github
cmd Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
dev
docs
frontend Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
i18n Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
internal Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
models
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml
config-demo.toml
config.toml.sample Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
CONTRIBUTING.md
docker-compose.yml Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
docker-entrypoint.sh Add support for running Docker container as non-root user using docker-entrypoint.sh (#1892) 2024-07-21 11:03:15 +05:30
Dockerfile
go.mod
go.sum Add public login page and auth middleware and handlers. 2024-10-13 16:59:51 +05:30
install-demo.sh
install-prod.sh
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
listmonk-simple.service
listmonk@.service
Makefile
project.inlang.json
queries.sql
README.md
schema.sql Refactor handler groups and add mising auth features like logout. 2024-10-13 16:59:51 +05:30
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 (⩾ 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
bash -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
bash -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 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.