knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-12-28 01:46:31 +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.
1061 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 f958f3d24b Add RSS feed to the public mailing list archive.
2022-11-10 23:30:53 +05:30
.github Remove redundant GitHub issue template. 2021-10-10 17:46:05 +05:30
cmd Add RSS feed to the public mailing list archive. 2022-11-10 23:30:53 +05:30
dev Provide a default configuration file for containerized development 2022-01-19 09:30:23 -05:00
frontend Add global site name setting to render name on public pages. 2022-11-10 23:30:53 +05:30
i18n Add global site name setting to render name on public pages. 2022-11-10 23:30:53 +05:30
internal Add global site name setting to render name on public pages. 2022-11-10 23:30:53 +05:30
models Add global site name setting to render name on public pages. 2022-11-10 23:30:53 +05:30
scripts Add script to merge and normalize i18n files 2021-04-14 13:52:13 +05:30
static Add RSS feed to the public mailing list archive. 2022-11-10 23:30:53 +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
.goreleaser.yml
config-demo.toml
config.toml.sample Add comment explicitly stating that DB has to be created externally. Closes #830. 2022-07-14 10:52:41 +05:30
CONTRIBUTING.md Added correct link to repo for docs contribution 2022-02-12 22:29:32 -05:00
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 Add RSS feed to the public mailing list archive. 2022-11-10 23:30:53 +05:30
go.sum Add RSS feed to the public mailing list archive. 2022-11-10 23:30:53 +05:30
install-demo.sh Fix whitespace inconsistency in install scripts 2021-08-28 19:13:51 +05:30
install-prod.sh fix(install-prod.sh): Make tr work with macOS 2021-12-15 14:44:00 +05:30
LICENSE
listmonk@.service
Makefile Use --idempotent and --yes flags when bootstrapping the dev db 2022-01-19 09:29:47 -05:00
queries.sql Fix archive template selection in campaign creation query. 2022-11-10 23:30:53 +05:30
README.md Remove Heroku buttons (as it has blocked listmonk without explanation). 2022-03-07 18:25:20 +05:30
schema.sql Add global site name setting to render name on public pages. 2022-11-10 23:30:53 +05:30
stats.sql
TODO.md
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 (⩾ 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.

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.