listmonk/README.md

<a href="https://zerodha.tech"><img src="https://zerodha.tech/static/images/github-badge.svg" align="right" /></a>

[![listmonk-logo](https://user-images.githubusercontent.com/547147/231084896-835dba66-2dfe-497c-ba0f-787564c0819e.png)](https://listmonk.app)

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](https://user-images.githubusercontent.com/547147/134939475-e0391111-f762-44cb-b056-6cb0857755e3.png)](https://listmonk.app)

Visit [listmonk.app](https://listmonk.app) for more info. Check out the [**live demo**](https://demo.listmonk.app).

## Installation

### Docker

The latest image is available on DockerHub at [`listmonk/listmonk:latest`](https://hub.docker.com/r/listmonk/listmonk/tags?page=1&ordering=last_updated&name=latest). Use the sample [docker-compose.yml](https://github.com/knadh/listmonk/blob/master/docker-compose.yml) to run manually or use the helper script. 

#### Demo

```bash
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

```bash
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](https://listmonk.app/docs/installation).

__________________

### Binary
- Download the [latest release](https://github.com/knadh/listmonk/releases) 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](https://listmonk.app/docs/installation).
__________________


## Developers
listmonk is free and open source software licensed under AGPLv3. If you are interested in contributing, refer to the [developer setup](https://listmonk.app/docs/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.
Add zerodha.tech badge 2020-09-22 02:16:57 +08:00			`<a href="https://zerodha.tech"><img src="https://zerodha.tech/static/images/github-badge.svg" align="right" /></a>`

Add white background to logo in README for dark mode. Closes #1268. 2023-04-11 15:21:24 +08:00			`[![listmonk-logo](https://user-images.githubusercontent.com/547147/231084896-835dba66-2dfe-497c-ba0f-787564c0819e.png)](https://listmonk.app)`
Refactor README for publishing 2019-06-26 18:35:50 +08:00
Update Postgres version in doc strings. 2023-07-28 02:15:39 +08:00			`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.`
Update README with image and links 2019-07-09 19:36:23 +08:00
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			`[![listmonk-dashboard](https://user-images.githubusercontent.com/547147/134939475-e0391111-f762-44cb-b056-6cb0857755e3.png)](https://listmonk.app)`

			`Visit [listmonk.app](https://listmonk.app) for more info. Check out the [live demo](https://demo.listmonk.app).`
Refactor README for publishing 2019-06-26 18:35:50 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`## Installation`
Refactor README for publishing 2019-06-26 18:35:50 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`### Docker`
Add support for loading custom static files with `--static-dir` - Removed duplicate copies of static files in `static/public/` 2020-03-14 23:37:14 +08:00
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			The latest image is available on DockerHub at [`listmonk/listmonk:latest`](https://hub.docker.com/r/listmonk/listmonk/tags?page=1&ordering=last_updated&name=latest). Use the sample [docker-compose.yml](https://github.com/knadh/listmonk/blob/master/docker-compose.yml) to run manually or use the helper script.
feat: Add docker instructions 2019-07-12 10:21:48 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`#### Demo`
feat: Add shell script for demo setup 2021-01-22 00:06:32 +08:00
			```bash
CD to directory before install script Change directory to newly created before running install script 2021-09-22 02:33:37 +08:00			`mkdir listmonk-demo && cd listmonk-demo`
fix: easy install docker script for macOS (#1742) * feat: fix easy install docker script for macOS Closes https://github.com/knadh/listmonk/issues/1740 * fix: use bash shebang for wider compatibility * fix: quote the command subst to prevent word splitting 2024-02-21 15:41:38 +08:00			`bash -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)"`
feat: Add shell script for demo setup 2021-01-22 00:06:32 +08:00			```
feat: Add docker image link to README 2019-07-12 20:27:32 +08:00
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			`DO NOT use this demo setup in production.`
feat: Add docker instructions 2019-07-12 10:21:48 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`#### Production`
feat: Add easy install script - Add a shell script to orchestrate a production setup with `docker-compose`. The script fetches config and `docker-compose.yml` from the `master` branch, generates a secure password, performs DB migrations and starts the container services. - Add a health check for Postgres container service in `docker-compose.yml`. - Add cusotm `container_name` for services inside `docker-compose`. This is helpful to check the status of containers in the install shell script. 2021-06-14 21:50:13 +08:00
			```bash
CD to directory before install script Change directory to newly created before running install script 2021-09-22 02:33:37 +08:00			`mkdir listmonk && cd listmonk`
fix: easy install docker script for macOS (#1742) * feat: fix easy install docker script for macOS Closes https://github.com/knadh/listmonk/issues/1740 * fix: use bash shebang for wider compatibility * fix: quote the command subst to prevent word splitting 2024-02-21 15:41:38 +08:00			`bash -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-prod.sh)"`
feat: Add easy install script - Add a shell script to orchestrate a production setup with `docker-compose`. The script fetches config and `docker-compose.yml` from the `master` branch, generates a secure password, performs DB migrations and starts the container services. - Add a health check for Postgres container service in `docker-compose.yml`. - Add cusotm `container_name` for services inside `docker-compose`. This is helpful to check the status of containers in the install shell script. 2021-06-14 21:50:13 +08:00			```
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			Visit `http://localhost:9000`.
feat: Add easy install script - Add a shell script to orchestrate a production setup with `docker-compose`. The script fetches config and `docker-compose.yml` from the `master` branch, generates a secure password, performs DB migrations and starts the container services. - Add a health check for Postgres container service in `docker-compose.yml`. - Add cusotm `container_name` for services inside `docker-compose`. This is helpful to check the status of containers in the install shell script. 2021-06-14 21:50:13 +08:00
Fix typo 2021-09-28 21:22:34 +08:00			`NOTE: Always examine the contents of shell scripts before executing them.`
feat: Add docker instructions 2019-07-12 10:21:48 +08:00
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			`See [installation docs](https://listmonk.app/docs/installation).`
feat: Add separate config for demo setup, tweak docs This PR adds `config-demo.toml` to `Dockerfile` which uses the db host `demo-db`. This is more suited for demo setups. For normal docker installations the db host is changed back to `db` which is a better sane default. Reworded `INSTALL.md` and `README.md` for more clarity on docker installation and configuration. 2020-07-09 01:08:31 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`__________________`
feat: Add docker demo setup 2019-07-12 16:20:44 +08:00
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`### Binary`
			`- Download the [latest release](https://github.com/knadh/listmonk/releases) 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`.
Add note about Heroku deploy button The Heroku deploy button provides automated on-click deployments to Heroku. 2020-04-02 18:23:01 +08:00
Update README to reflect v2.0.0 changes. 2021-09-27 23:48:01 +08:00			`See [installation docs](https://listmonk.app/docs/installation).`
Add rebranded design elements. - New logo and favicon and new splash image + intro text in the README. 2020-08-09 21:45:44 +08:00			`__________________`

Refactor README for publishing 2019-06-26 18:35:50 +08:00
			`## Developers`
Update README.md (#2034) 'software', when used as a noun, is not a 'countable' type, and it does not get an article like 'a'. It's like 'traffic'. 2024-09-06 18:19:53 +08:00			`listmonk is free and open source software licensed under AGPLv3. If you are interested in contributing, refer to the [developer setup](https://listmonk.app/docs/developer-setup). The backend is written in Go and the frontend is Vue with Buefy for UI.`
Refactor README for publishing 2019-06-26 18:35:50 +08:00
Refactor and add new build routines - Fix version injection in build - Refactor Makefile - Add --new-config flag to generate sample config - Add license - Remove autogenerated frontend README - Refactor make dist to do end-to-end build - Refactor build and add goreleaser conf 2019-07-08 20:51:44 +08:00
			`## License`
			`listmonk is licensed under the AGPL v3 license.`