mailtrain/README.md at 286434d84613c3493b073714ac61831794478ce3

Programster 286434d846 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 is a self hosted newsletter application built on Node.js (v7+) and MySQL (v5.5+ or MariaDB).

Features

Subscribe to Mailtrain Newsletter here (uses Mailtrain obviously)

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) 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
Open 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 and update service configuration.
Navigate to http://localhost:3000/users/account and update user information and password.

Download Mailtrain files using git: git clone git://github.com/Mailtrain-org/mailtrain.git (or download zipped repo) and open Mailtrain folder cd mailtrain
Run npm install --production in the Mailtrain folder to install required dependencies
Copy config/default.toml as config/production.toml and update MySQL and any other settings in it
Run the server NODE_ENV=production npm start
Open http://localhost:3000/
Authenticate as admin:test
Navigate to http://localhost:3000/settings and update service configuration
Navigate to http://localhost:3000/users/account and update user information and password

For more information, please read the docs.