public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

* Undoing my change of swapping out the mailtrain title with the logo because it looks wierd as the logo has too much whitespace.

Browse source 
* Adding the information about Node js version requirement to the manual installation instructions.
This commit is contained in:
Programster 2017-09-27 02:13:11 +00:00
parent 286434d846
commit 8bd9b5bc9e
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -1,7 +1,9 @@
![](http://mailtrain.org/mailtrain.png)
# Mailtrain
[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)
## Features
* Subscriber list management
@ -35,6 +37,9 @@ Depending on how you have configured your system and Docker you may need to prep
## Quick Start - Manual Install (any OS that supports Node.js)
### Requirements:
* 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
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
3. Copy [config/default.toml](config/default.toml) as `config/production.toml` and update MySQL and any other settings in it