knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-12-26 00:42:58 +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.
1566 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 c35ed68759 Fix quotes in JSON API req example in docs.
2024-11-05 00:21:36 +05:30
.github Remove deprecated goreleaser flag from GitHub action workflow. 2024-10-27 18:36:02 +05:30
cmd Reject blocklist-by-query API requests with no query. 2024-11-05 00:18:22 +05:30
dev
docs Fix quotes in JSON API req example in docs. 2024-11-05 00:21:36 +05:30
frontend fix dummy detection for OIDC client secret (#2116) 2024-10-29 10:36:17 +05:30
i18n Update it.json (#2134) 2024-11-04 15:13:56 +05:30
internal Change v4.0.0 migration script to not auto-generate credentials. 2024-10-27 17:18:28 +05:30
models
scripts
static fix: favicon markup (#2115) 2024-10-30 00:05:03 +05:30
.dockerignore
.gitattributes
.gitignore
.goreleaser.yml Remove obsolete demo file reference from Docker build commands. 2024-10-27 18:55:21 +05:30
config.toml.sample
CONTRIBUTING.md
docker-compose.yml Fix incorrect image tag in docker-compose. 2024-10-27 18:00:30 +05:30
docker-entrypoint.sh Don't fail on chown in Docker entry script. Closes #2104. 2024-10-28 12:56:49 +05:30
Dockerfile #2114 - Fix issue of wrong platform used during docker build (#2123) 2024-10-30 10:13:00 +05:30
go.mod Bump google.golang.org/protobuf from 1.31.0 to 1.33.0 (#2083) 2024-10-27 17:24:56 +05:30
go.sum Bump google.golang.org/protobuf from 1.31.0 to 1.33.0 (#2083) 2024-10-27 17:24:56 +05:30
LICENSE
listmonk-simple.service
listmonk@.service
Makefile Update gorelease command and remove deprecated flags. 2024-10-27 18:14:32 +05:30
permissions.json
project.inlang.json
queries.sql
README.md Fix docker-compose curl command examples. 2024-10-28 00:16:26 +05:30
schema.sql Change v4.0.0 migration script to not auto-generate credentials. 2024-10-27 17:18:28 +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. Download and use the sample docker-compose.yml.

# Download the compose file to the current directory.
curl -LO https://github.com/knadh/listmonk/raw/master/docker-compose.yml

# Run the services in the background.
docker compose up -d

Visit http://localhost:9000

See installation docs

Binary

  • Download the latest release and extract the listmonk binary.
  • ./listmonk --new-config to generate config.toml. Edit it.
  • ./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.