public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
No description
569 commits 9 branches 34 tags 30 MiB
Find a file
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
config Added note about mysql timezone option. #311 #134 2017-09-15 22:17:54 +02:00
docs 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
languages Added spanish es_ES translations 2017-06-23 22:57:48 +02:00
lib findMailByResponse now searches in latest campaigns first 2017-07-13 22:29:55 +02:00
protected/reports Halfway through in refactoring the report generation to a separate process running asynchronously of the Express server. 2017-04-17 18:31:01 -04:00
public Fixed/reverted Mosaico social icons 2017-06-20 21:27:51 +02:00
routes Fixes #298 - Import CSV didn't show hidden custom fields 2017-09-22 14:26:47 +02:00
services Honour tracking settings from parent RSS-Campaign, fixes #319 2017-09-22 11:39:01 +02:00
setup Updated e2e subscription tests 2017-06-11 18:49:02 +02:00
tasks initial translations support 2017-03-04 18:15:16 +02:00
test Disable eslint rule no-await-in-loop for e2e tests 2017-06-15 21:28:40 +02:00
views Added documentation for API endpoint /api/field/:listId 2017-07-06 15:08:35 +02:00
workers/reports Additions to the install scripts 2017-04-27 19:30:11 -04:00
.dockerignore Add node_modules to .dockerignore to avoid unneeded building time / overhead 2017-06-24 18:17:34 -05:00
.eslintrc Updated translation support 2017-03-07 16:30:56 +02:00
.gitignore add package-lock.json file to gitignore 2017-09-20 11:59:23 +07:00
.travis.yml Fixed Travis CI Checks 2017-07-13 22:45:35 +02:00
app.js Half way in improving e2e test infrastructure and refactoring tests to the enhanced (un)subscription process 2017-05-23 04:15:32 +02:00
BACKERS.md v1.14.0 2016-07-09 11:23:07 +03:00
CHANGELOG.md v1.23.2 2017-04-04 12:41:32 +03:00
docker-compose.override.yml.tmpl Make docker-compose.override.yml a template 2017-06-24 18:20:15 -05:00
docker-compose.yml Add volume for reports 2017-06-24 18:22:38 -05:00
docker-entrypoint.sh Use production.toml for reports when it exists in config 2017-06-24 18:49:35 -05:00
Dockerfile Update Dockerfile to avoid file system permission issues 2017-06-24 19:40:43 -05:00
Gruntfile.js Satisfy eslint rule linebreak-style 2017-06-22 18:25:13 +02:00
index.js Report processor worker refactored to run under another user (nobody) and have its own mysql credentials. 2017-04-27 16:35:53 -04:00
LICENSE v1.22.0 2017-03-02 15:31:06 +02:00
meta.json Merge with upstream 2017-05-27 14:07:56 +02:00
package.json Bump deps 2017-09-26 14:10:16 +02:00
README.md 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

README.md

Mailtrain is a self hosted newsletter application built on Node.js (v7+) and MySQL (v5.5+ or MariaDB).

Features

  • Subscriber list management
  • List segmentation
  • Custom fields
  • Email templates
  • Large CSV list import files

Subscribe to Mailtrain Newsletter here (uses Mailtrain obviously)

Hardware Requirements

  • 1 vCPU
  • 1024 MB RAM

Quick Start - Deploy with Docker

Requirements:

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) 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.

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) and open Mailtrain folder cd mailtrain
  2. Run npm install --production in the Mailtrain folder to install required dependencies
  3. Copy 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/
  6. Authenticate as admin:test
  7. Navigate to http://localhost:3000/settings and update service configuration
  8. Navigate to http://localhost:3000/users/account and update user information and password

Read The Docs

For more information, please read the docs.

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