knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-12-29 02:14:04 +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.
1537 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 7fcc6f71e2 Simplify and refactor docker-compose.yml and remove install scripts. 
- Remove "demo", "production" containers and have just one.
- Remove dependency on config.toml and inline config to env vars.
- Have a single idempotent instal+upgrade+run command that eliminates
  the need for manual upgrade steps.
- Remove `.sh` install scripts.
- Simplify and clean up install and update docs.
2024-10-27 15:36:35 +05:30
.github Add missing GH token to Swagger docs workflow. 2024-10-23 12:31:01 +05:30
cmd Add first-time Super Admin setup UI on fresh install. 2024-10-26 19:47:01 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
docs Simplify and refactor docker-compose.yml and remove install scripts. 2024-10-27 15:36:35 +05:30
frontend Add first-time Super Admin setup UI on fresh install. 2024-10-26 19:47:01 +05:30
i18n Add first-time Super Admin setup UI on fresh install. 2024-10-26 19:47:01 +05:30
internal Separate get individual user and get all users queries. 2024-10-26 17:03:02 +05:30
models Separate get individual user and get all users queries. 2024-10-26 17:03:02 +05:30
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static Add first time login setup template 2024-10-27 15:14:31 +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 running Docker container as non-root user using docker-entrypoint.sh (#1892) 2024-07-21 11:03:15 +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 Remove admin user/password from sample config generation. 2024-10-13 16:59:52 +05:30
CONTRIBUTING.md Fix link to the docs repo. 2023-03-26 11:17:15 +05:30
docker-compose.yml Simplify and refactor docker-compose.yml and remove install scripts. 2024-10-27 15:36:35 +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 Add support for running Docker container as non-root user using docker-entrypoint.sh (#1892) 2024-07-21 11:03:15 +05:30
go.mod Upgrade simplesessions to v3. 2024-10-13 16:59:51 +05:30
go.sum Upgrade simplesessions to v3. 2024-10-13 16:59:51 +05:30
LICENSE Refactor and add new build routines 2019-07-09 15:57:04 +05:30
listmonk-simple.service Update listmonk-simple.service - add optional log file (#1640) 2024-01-09 23:41:14 +05:30
listmonk@.service Enable extra system calls in systemd service (#1309) 2023-07-12 19:42:54 +05:30
Makefile Refactor 'super' user type to a pre-defined super admin role. 2024-10-13 16:59:52 +05:30
permissions.json Add list permission check to subscriber calls. 2024-10-13 17:03:55 +05:30
project.inlang.json fix: update inlang settings (#1529) 2023-09-20 14:19:08 +05:30
queries.sql Update user login time on password login. 2024-10-26 23:56:12 +05:30
README.md Simplify and refactor docker-compose.yml and remove install scripts. 2024-10-27 15:36:35 +05:30
schema.sql Fix and refactor subscriber batch fetching in campaign processing. 2024-10-13 17:03:59 +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. Download and use the sample docker-compose.yml.

# Download the compose file to the current directory.
curl -O https://github.com/knadh/listmonk/blob/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.