public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
No description
796 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 eacdc74c29 CKEditor components replaced by CKEditor 5. 
Remains of the sandboxed CKEditor - will be removed, but the version here may be useful for another editor that is prone to XSS (like Summernote).
2018-11-03 21:46:23 +01:00
client CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
config Client's public folder renamed to static 2018-09-18 10:30:13 +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 add missing translations 2018-06-15 09:41:14 +02:00
lib CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
models CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01: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
routes CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
services Bugfixes in sending campaigns 2018-09-27 21:32:35 +02:00
setup Checks for dependencies during deletion. 2018-09-29 20:08:49 +02:00
shared CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
test Client's public folder renamed to static 2018-09-18 10:30:13 +02:00
views CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
workers/reports Bugfixes in sending campaigns 2018-09-27 21:32:35 +02: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 Client's public folder renamed to static 2018-09-18 10:30:13 +02:00
.travis.yml Fixed Travis CI Checks 2017-07-13 22:45:35 +02:00
access-control.md Lists list and CUD 2017-07-29 22:42:07 +03:00
app-builder.js CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
BACKERS.md Removed obsolete dir 2018-09-29 13:30:29 +02: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 Client's public folder renamed to static 2018-09-18 10:30:13 +02:00
docker-entrypoint.sh Use production.toml for reports when it exists in config 2017-06-24 18:49:35 -05:00
Dockerfile Added ldapauth support to docker 2018-02-13 14:54:17 +00:00
Gruntfile.js Satisfy eslint rule linebreak-style 2017-06-22 18:25:13 +02:00
index.js Bugfixes in sending campaigns 2018-09-27 21:32:35 +02:00
LICENSE v1.22.0 2017-03-02 15:31:06 +02:00
package-lock.json Updated packages to remove vulnerabilities reported by npm 2018-09-02 14:59:02 +02:00
package.json Updated packages to remove vulnerabilities reported by npm 2018-09-02 14:59:02 +02:00
README.md Fix newsletter signup link in README 2018-05-23 11:33:08 -05:00
TODO.md CKEditor components replaced by CKEditor 5. 2018-11-03 21:46:23 +01:00
UPGRADE.md Before renaming imports to tasks 2018-09-23 22:28:58 +02:00

README.md

Mailtrain

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