From d13c33590d869054cfe557d225d6f4219bf63510 Mon Sep 17 00:00:00 2001 From: shailysangwan Date: Wed, 23 Oct 2019 17:06:03 +0530 Subject: [PATCH] update instructions for local installation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6748a3b..cec70c9 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ listmonk is a standalone, self-hosted, newsletter and mailing list manager. It i ### Installation and use -- Download the [latest release](https://github.com/knadh/listmonk/releases) and extract the listmonk binary somewhere. -- Run `./listmonk --new-config` to generate a sample `config.toml` and add your configuration (SMTP and Postgres DB credentials primarily). +- Download the [latest release](https://github.com/knadh/listmonk/releases) for your platform and extract the listmonk binary. For example: `tar -C $HOME/listmonk -xzf listmonk_$VERSION_$OS_$ARCH.tar.gz` +- Navigate to the directory containing the binary (`cd $HOME/listmonk`) and run `./listmonk --new-config` to generate a sample `config.toml` and add your configuration (SMTP and Postgres DB credentials primarily). - `./listmonk --install` to setup the DB. - Run `./listmonk` and 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.