forked from knadh/listmonk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
45 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,4 @@ frontend/yarn.lock | |
.vscode/ | ||
|
||
config.toml | ||
node_modules |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,45 @@ | ||
# listmonk | ||
![listmonk](https://user-images.githubusercontent.com/547147/60170989-41681f00-9827-11e9-93a8-a871a40be913.png) | ||
|
||
See [developer README](README.dev.md). | ||
> listmonk is **alpha** software and may change and break. Use with caution. That said, it has been in active use at [zerodha.com](https://zerodha.com) for several months where it has processed hundreds of campaigns and tens of millions of e-mails. | ||
listmonk is a standalone newsletter and mailing list manager written in Go. It is fast, performant, and comes as a single binary. It uses a PostgreSQL database as its data store. | ||
|
||
### Installation and use | ||
|
||
- Download the [latest release](https://github.com/knadh/listmonk/releases) and extract the listmonk binary somewhere. | ||
- Copy `config.toml.sample` to `config.toml` and add your configuration (SMTP and Postgres DB credentials primarily). | ||
- `./listmonk --install` to setup the DB. | ||
- Visit `http://localhost:9000`. | ||
- Since there is no user auth yet, it's best to put listmonk behind a proxy like Nginx and setup basicauth on all endpoints except for the few endpoints that need to be public. Here is a [sample nginx config](https://github.com/knadh/listmonk/wiki/Production-Nginx-config) for production use. | ||
|
||
### Current features | ||
|
||
- Admin dashboard | ||
- Multiple public and private lists | ||
- Fast bulk subscriber import | ||
- Custom subscriber attributes | ||
- Subscriber querying and segmentation with ad-hoc SQL | ||
- Rich Go templates and WYSIWYG editor | ||
- Media gallery | ||
- Multi-threaded multi-SMTP e-mail queues for fast campaign delivery | ||
- HTTP/JSON APIs for everything | ||
- Clicks and view tracking | ||
- and more ... | ||
|
||
### Todo | ||
|
||
- DB migrations | ||
- Bounce tracking | ||
- User auth, management, permissions | ||
- Privacy features for subscribers (Download and wipe all tracking data) | ||
- Ability to write raw campaign logs to a target | ||
- Analytics views and reports | ||
- Make Ant design UI components responsive | ||
- Better widgets on dashboard | ||
- Tests! | ||
|
||
## Developers | ||
|
||
listmonk is free, open source software licensed under AGPLv3. There are a few of essential features such as user auth/management and bounce tracking that are currently missing. Contributions are welcome. | ||
|
||
The backend is written in Go and the frontend is in React with Ant Design for UI. See [developer setup](https://github.com/knadh/listmonk/wiki/Developer-setup) to get started. |