public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
No description
831 commits 9 branches 34 tags 30 MiB
JavaScript 33.3%
Gettext Catalog 29.6%
HTML 16.3%
Modelica 14.3%
SQL 4.2%
Other 2.3%
Find a file
Tomas Bures bd20072455 Save button for template editors
2018-11-22 20:53:44 +01:00
client Save button for template editors 2018-11-22 20:53:44 +01:00
docker New project structure 2018-11-18 15:38:52 +01:00
docs Finished support for triggered campaigns. So far only smoke-tested for subscription trigger. 2018-11-21 01:41:10 +03:00
locales Updates in translations 2018-11-22 11:32:30 +01:00
server Removed CKEditor 5 because it was of little use and doubled the code size of root.js 2018-11-22 15:21:15 +01:00
shared Removed CKEditor 5 because it was of little use and doubled the code size of root.js 2018-11-22 15:21:15 +01:00
.dockerignore Add node_modules to .dockerignore to avoid unneeded building time / overhead 2017-06-24 18:17:34 -05:00
.gitignore New project structure 2018-11-18 15:38:52 +01:00
.gitmodules Included MJML4 2018-11-10 02:05:26 +01:00
.travis.yml Fixed Travis CI Checks 2017-07-13 22:45:35 +02:00
CHANGELOG.md New project structure 2018-11-18 15:38:52 +01:00
LICENSE v1.22.0 2017-03-02 15:31:06 +02:00
README.md New project structure 2018-11-18 15:38:52 +01:00
TODO.md New project structure 2018-11-18 15:38:52 +01:00
UPGRADE.md Finished support for triggered campaigns. So far only smoke-tested for subscription trigger. 2018-11-21 01:41:10 +03:00

README.md

Mailtrain

Mailtrain is a self hosted newsletter application built on Node.js (v10+) and MySQL (v8+) or MariaDB (v10+).

Features

  • Subscriber list management
  • List segmentation
  • Custom fields
  • Email templates (including MJML-based templates)
  • Large CSV list import files
  • Custom reports
  • Automation (triggered and RSS campaigns)
  • Multiple users with granular user permissions and flexible sharing
  • Hierarchical namespaces for enterprise-level situations

Hardware Requirements

  • 1 vCPU
  • 2048 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
  • Start: docker-compose start
  • 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)

Requirements:

  • Mailtrain requires at least Node.js v10.
  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

GPL-V3.0