From 60badb2198d954596b9d327f205d987e01384a34 Mon Sep 17 00:00:00 2001 From: Kailash Nadh Date: Mon, 27 Sep 2021 21:18:01 +0530 Subject: [PATCH] Update README to reflect v2.0.0 changes. --- README.md | 38 ++++++++++---------------------------- 1 file changed, 10 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index de607e3..eead816 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -![listmonk](https://user-images.githubusercontent.com/547147/89733021-43fbf700-da70-11ea-82e4-e98cb5010257.png) +[![listmonk-logo](https://user-images.githubusercontent.com/547147/134940003-1de03d83-8c7b-459b-8056-baa8d5f3b448.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 database as its data store. -[![listmonk-dashboard](https://user-images.githubusercontent.com/547147/89733057-87566580-da70-11ea-8160-855f6f046a55.png)](https://listmonk.app) -Visit [listmonk.app](https://listmonk.app) +[![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`. Use the sample [docker-compose.yml](https://github.com/knadh/listmonk/blob/master/docker-compose.yml) to run listmonk and Postgres DB with docker-compose as follows: +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 @@ -20,39 +21,19 @@ mkdir listmonk-demo && cd listmonk-demo sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)" ``` -The demo does not persist Postgres after the containers are removed. DO NOT use this demo setup in production. +DO NOT use this demo setup in production. #### Production -##### Easy Docker install - -This setup is recommended if you want to _quickly_ setup `listmonk` in production. - ```bash mkdir listmonk && cd listmonk sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-prod.sh)" ``` +Visit `http://localhost:9000`. -The above shell script performs the following actions: +**NOTE**: Always exmaine the contents of shell scripts before executing them. -- Downloads `docker-compose.yml` and generates a `config.toml`. -- Runs a Postgres container and installs the database schema. -- Runs the `listmonk` container. - -**NOTE**: It's recommended to examine the contents of the shell script, before running in your environment. - -##### Manual Docker install - -The following workflow is recommended to setup `listmonk` manually using `docker-compose`. You are encouraged to customise the contents of `docker-compose.yml` to your needs. The overall setup looks like: - -- `docker-compose up db` to run the Postgres DB. -- `docker-compose run --rm app ./listmonk --install` to setup the DB (or `--upgrade` to upgrade an existing DB). -- Copy `config.toml.sample` to your directory and make the following changes: - - `app.address` => `0.0.0.0:9000` (Port forwarding on Docker will work only if the app is advertising on all interfaces.) - - `db.host` => `listmonk_db` (Container Name of the DB container) -- Run `docker-compose up app` and visit `http://localhost:9000`. - -More information on [docs](https://listmonk.app/docs). +See [installation docs](https://listmonk.app/docs/installation). __________________ @@ -62,6 +43,7 @@ __________________ - `./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). __________________ ### Heroku