diff --git a/README.md b/README.md index 3b1d39e7..a02d3033 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ -# Mailtrain +![](http://mailtrain.org/mailtrain.png) [Mailtrain](http://mailtrain.org) is a self hosted newsletter application built on Node.js (v7+) and MySQL (v5.5+ or MariaDB). -![](http://mailtrain.org/mailtrain.png) - -> Mailtrain requires at least **Node.js v7**. If you want to use an older version of Node.js then you should use version v1.24 of Mailtrain. You can either download it [here](https://github.com/Mailtrain-org/mailtrain/archive/v1.24.0.zip) or if using git then run `git checkout v1.24.0` before starting it - ## Features -* subscriber list management -* list segmentation -* custom fields -* email templates -* large CSV list import files +* Subscriber list management +* List segmentation +* Custom fields +* Email templates +* Large CSV list import files Subscribe to Mailtrain Newsletter [here](http://mailtrain.org/subscription/EysIv8sAx) (uses Mailtrain obviously) @@ -27,22 +23,17 @@ Subscribe to Mailtrain Newsletter [here](http://mailtrain.org/subscription/EysIv * [Docker Compose](https://docs.docker.com/compose/) #### Steps: +Depending on how you have configured your system and Docker you may need to prepend the commands below with `sudo`. * Download Mailtrain files using git: `git clone git://github.com/Mailtrain-org/mailtrain.git` (or download [zipped repo](https://github.com/Mailtrain-org/mailtrain/archive/master.zip)) and open Mailtrain folder `cd mailtrain` -* **Note**: depending on how you have configured your system and Docker you may need to prepend the commands below with `sudo`. * Copy the file `docker-compose.override.yml.tmpl` to `docker-compose.override.yml` and modify it if you need to. * Bring up the stack with: `docker-compose up -d` - * by default it will use the included `docker-compose.yml` file and override some configurations taken from the `docker-compose.override.yml` file. -* If you want to use only / copy the `docker-compose.yml` file (for example, if you were deploying with Rancher), you may need to first run `docker-compose build` to make sure your system has a Docker image `mailtrain:latest`. * Open [http://localhost:3000/](http://localhost:3000/) (change the host name `localhost` to the name of the host where you are deploying the system). * Authenticate as user `admin` with password `test` * Navigate to [http://localhost:3000/settings](http://localhost:3000/settings) and update service configuration. * Navigate to [http://localhost:3000/users/account](http://localhost:3000/users/account) and update user information and password. -**Note**: If you need to add or modify custom configurations, copy the file `config/docker-production.toml.tmpl` to `config/production.toml` and modify as you need. By default, the Docker image will do just that, automatically, so you can bring up the stack and it will work with default configurations. - - -## Manual Install (any OS that supports Node.js) +## Quick Start - Manual Install (any OS that supports Node.js) 1. Download Mailtrain files using git: `git clone git://github.com/Mailtrain-org/mailtrain.git` (or download [zipped repo](https://github.com/Mailtrain-org/mailtrain/archive/master.zip)) and open Mailtrain folder `cd mailtrain` 2. Run `npm install --production` in the Mailtrain folder to install required dependencies @@ -62,4 +53,4 @@ For more information, please [read the docs](http://docs.mailtrain.org/). * Versions 1.22.0 and up **GPL-V3.0** * Versions 1.21.0 and up: **EUPL-1.1** * Versions 1.19.0 and up: **MIT** - * Up to versions 1.18.0 **GPL-V3.0** + * Up to versions 1.18.0 **GPL-V3.0** \ No newline at end of file