mailtrain/README.md

# 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
* List segmentation
* Custom fields
* Email templates
* Large CSV list import files

Subscribe to Mailtrain Newsletter [here](https://mailtrain.org/subscription/S18sew2wM) (uses Mailtrain obviously)

## Hardware Requirements
* 1 vCPU
* 1024 MB RAM

## Quick Start - Deploy with Docker
#### Requirements:

  * [Docker](https://www.docker.com/)
  * [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`
* 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`
* Start: `docker-compose start`
* 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.

## 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
  4. Run the server `NODE_ENV=production npm start`
  5. Open [http://localhost:3000/](http://localhost:3000/)
  6. Authenticate as `admin`:`test`
  7. Navigate to [http://localhost:3000/settings](http://localhost:3000/settings) and update service configuration
  8. Navigate to [http://localhost:3000/users/account](http://localhost:3000/users/account) and update user information and password

## Read The Docs
For more information, please [read the docs](http://docs.mailtrain.org/).


## License

  * 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**
* Undoing my change of swapping out the mailtrain title with the logo because it looks wierd as the logo has too much whitespace. * Adding the information about Node js version requirement to the manual installation instructions. 2017-09-27 02:13:11 +00:00			`# Mailtrain`
Updated README 2016-04-04 12:42:36 +00:00
Trying to slim down the front README page. If user's need more detailed information, such as how to deploy on Rancher, they should read the docs area. 2017-09-27 02:03:34 +00:00			`[Mailtrain](http://mailtrain.org) is a self hosted newsletter application built on Node.js (v7+) and MySQL (v5.5+ or MariaDB).`
Updated README, added note about Mailtrain versions 2017-05-16 13:39:17 +00:00
* Undoing my change of swapping out the mailtrain title with the logo because it looks wierd as the logo has too much whitespace. * Adding the information about Node js version requirement to the manual installation instructions. 2017-09-27 02:13:11 +00:00			`![](http://mailtrain.org/mailtrain.png)`

Updated README 2016-04-04 12:42:36 +00:00			`## Features`

Trying to slim down the front README page. If user's need more detailed information, such as how to deploy on Rancher, they should read the docs area. 2017-09-27 02:03:34 +00:00			`* Subscriber list management`
			`* List segmentation`
			`* Custom fields`
			`* Email templates`
			`* Large CSV list import files`
Updated README 2016-04-04 12:42:36 +00:00
Fix newsletter signup link in README 2018-05-23 16:33:08 +00:00			`Subscribe to Mailtrain Newsletter [here](https://mailtrain.org/subscription/S18sew2wM) (uses Mailtrain obviously)`
Added subscription link 2016-04-04 13:17:22 +00:00
Moving the majority of the documentation from the README file to the documents area and referencing it. 2017-09-27 01:55:19 +00:00			`## Hardware Requirements`
			`* 1 vCPU`
			`* 1024 MB RAM`
Addition of Table of Contents 2017-03-08 16:04:27 +00:00
Moving the majority of the documentation from the README file to the documents area and referencing it. 2017-09-27 01:55:19 +00:00			`## Quick Start - Deploy with Docker`
Update README 2017-06-24 23:31:57 +00:00			`#### Requirements:`
[feature] Add Dockerfile and update README 2017-03-17 14:48:50 +00:00
Update README 2017-06-24 23:31:57 +00:00			`* [Docker](https://www.docker.com/)`
			`* [Docker Compose](https://docs.docker.com/compose/)`

Moving the majority of the documentation from the README file to the documents area and referencing it. 2017-09-27 01:55:19 +00:00			`#### Steps:`
Trying to slim down the front README page. If user's need more detailed information, such as how to deploy on Rancher, they should read the docs area. 2017-09-27 02:03:34 +00:00			Depending on how you have configured your system and Docker you may need to prepend the commands below with `sudo`.
Update README 2017-06-24 23:31:57 +00:00
			* 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`
Fix docker install instructions Change extension name of copied docker- compose-override file to not be the same as source 2017-07-21 13:47:10 +00:00			* Copy the file `docker-compose.override.yml.tmpl` to `docker-compose.override.yml` and modify it if you need to.
Moving the majority of the documentation from the README file to the documents area and referencing it. 2017-09-27 01:55:19 +00:00			* Bring up the stack with: `docker-compose up -d`
Update README.md 2018-04-10 11:59:29 +00:00			* Start: `docker-compose start`
Update README 2017-06-24 23:31:57 +00:00			* 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.`

Trying to slim down the front README page. If user's need more detailed information, such as how to deploy on Rancher, they should read the docs area. 2017-09-27 02:03:34 +00:00			`## Quick Start - Manual Install (any OS that supports Node.js)`
Added installation script 2016-04-28 20:34:44 +00:00
* Undoing my change of swapping out the mailtrain title with the logo because it looks wierd as the logo has too much whitespace. * Adding the information about Node js version requirement to the manual installation instructions. 2017-09-27 02:13:11 +00:00			`### 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

Replaced andris9 with Mailtrain-org 2017-03-23 13:47:00 +00:00			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`
Update README.md 2016-04-28 19:47:53 +00:00			2. Run `npm install --production` in the Mailtrain folder to install required dependencies
Added SQL upgrade script 2016-04-19 09:05:13 +00:00			3. Copy [config/default.toml](config/default.toml) as `config/production.toml` and update MySQL and any other settings in it
Do not use mysql command for setting up databases 2016-04-25 10:59:00 +00:00			4. Run the server `NODE_ENV=production npm start`
			`5. Open [http://localhost:3000/](http://localhost:3000/)`
			6. Authenticate as `admin`:`test`
			`7. Navigate to [http://localhost:3000/settings](http://localhost:3000/settings) and update service configuration`
			`8. Navigate to [http://localhost:3000/users/account](http://localhost:3000/users/account) and update user information and password`
Initial import 2016-04-04 12:36:30 +00:00
Moving the majority of the documentation from the README file to the documents area and referencing it. 2017-09-27 01:55:19 +00:00			`## Read The Docs`
			`For more information, please [read the docs](http://docs.mailtrain.org/).`
initial translations support 2017-03-04 16:15:16 +00:00
updated readme 2017-03-04 16:20:32 +00:00
Initial import 2016-04-04 12:36:30 +00:00			`## License`

v1.22.0 2017-03-02 13:31:06 +00:00			`* Versions 1.22.0 and up GPL-V3.0`
added support for ses 2017-02-17 13:56:55 +00:00			`* Versions 1.21.0 and up: EUPL-1.1`
v1.19.0 2016-09-15 06:57:19 +00:00			`* Versions 1.19.0 and up: MIT`
Update README.md 2018-04-10 11:59:29 +00:00			`* Up to versions 1.18.0 GPL-V3.0`