diff --git a/.dockerignore b/.dockerignore
index b512c09d..c81bbd22 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -1 +1,9 @@
-node_modules
\ No newline at end of file
+node_modules/
+docs/
+Dockerfile
+*.md
+.git
+.gitignore
+.gitmodules
+docker-compose.yml
+docker-compose-local.yml
\ No newline at end of file
diff --git a/.eslintrc b/.eslintrc
deleted file mode 100644
index 91926fcd..00000000
--- a/.eslintrc
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "extends": "nodemailer"
-}
diff --git a/.gitignore b/.gitignore
index dbd42224..96ac666e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,34 +1,9 @@
/.idea
+/.vscode
/last-failed-e2e-test.*
node_modules
npm-debug.log
-package-lock.json
.DS_Store
-config/development*
-config/production*
-config/test*
-workers/reports/config/development.*
-workers/reports/config/production.*
-workers/reports/config/test.*
dump.rdb
-# generate POT file every time you want to update your PO file
-languages/mailtrain.pot
-
-public/mosaico/uploads/*
-!public/mosaico/uploads/README.md
-public/mosaico/custom/*
-!public/mosaico/custom/README.md
-public/mosaico/templates/*
-!public/mosaico/templates/versafix-1
-
-public/grapejs/uploads/*
-!public/grapejs/uploads/README.md
-public/grapejs/templates/*
-!public/grapejs/templates/demo
-!public/grapejs/templates/aves
-
-config/production.toml
-workers/reports/config/production.toml
-docker-compose.override.yml
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 00000000..a3472fb0
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "mvis/ivis-core"]
+ path = mvis/ivis-core
+ url = https://github.com/smartarch/ivis-core.git
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index dc5ea4b5..00000000
--- a/.travis.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-dist: trusty
-sudo: required
-language: node_js
-node_js:
- - 8
-services:
- - mysql
-before_install:
- - sudo apt-get -q -y install pwgen imagemagick
-install:
- - sudo bash test/e2e/install.sh
- - npm install
-before_script:
- - npm run starttest > /dev/null 2>&1 &
- - sleep 10
-script:
- - grunt
- - npm run _e2e
diff --git a/BACKERS.md b/BACKERS.md
deleted file mode 100644
index 6439658d..00000000
--- a/BACKERS.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# Crowdfunding Backers
-
-Mailtrain received funding from a [crowdfunding campaign](https://www.indiegogo.com/at/mailtrain/8720095). This was to enable me to spend the time required to get automation support into Mailtrain. These are the people who contributed to this fund raiser.
-
- * iRedMail - free, open source mail server solution <[www.iredmail.org](http://www.iredmail.org/)>
- * Richard Adleta
- * Wes Bos
- * Christophe Lombart
- * Anselm Hannemann
- * Jens Carroll
- * Anonymous
- * Brett Nelson
- * Jason Pelker
- * Leif Singer
- * Eve Land
- * Diana Espino
- * Moussa Clarke
- * Carl Hauschke
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7b18d957..400e3c8a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,149 +1,5 @@
# Changelog
-## 1.23.2 2017-04-04
+## 2.0.0-rc1 2018-12-25
- * Allow skipping DNS check for imports
- * Added option to use subscription widgets
-
-## 1.23.0 2017-03-19
-
- * Fixed security issue where description tags were able to include script tags. Reported by Andreas Lindh. Fixed with [ae6affda](https://github.com/Mailtrain-org/mailtrain/commit/ae6affda8193f034e06f7e095ee23821a83d5190)
- * Fixed security issue where templates that looked like file paths loaded content from arbitrary files. Reported by Andreas Lindh. Fixed with [0879fa41](https://github.com/Mailtrain-org/mailtrain/commit/0879fa412a2d4a417aeca5cd5092a8f86531e7ef)
- * Fixed security issue where users were able to use html tags in subscription values. Reported by Andreas Lindh. Fixed with [9d5fb816](https://github.com/Mailtrain-org/mailtrain/commit/9d5fb816c937114966d4f589e1ad4e164ff3a187)
- * Support for multiple HTML editors (Mosaico, GrapeJS, Summernote, HTML code)
-
-## 1.22.0 2017-03-02
-
- * Reverted license back to GPL-v3 to support Mosaico
-
-## 1.21.0 2017-02-17
-
- * Changed license from MIT to EUPL-1.1
- * Added support for sending mail using AWS SES
-
-## 1.20.0 2016-12-11
-
- * Added option to distribute sending queue between multiple processes to speed up delivery
-
-## 1.19.0 2016-09-15
-
- * Changed license from GPL-V3 to MIT
-
-## 1.18.0 2016-09-08
-
- * Updated installation script to bundle ZoneMTA as the default sending engine
- * Added new option to disable clicked and opened tracking
- * Store remote IP for subscription confirmations
-
-## 1.17.0 2016-08-29
-
- * Added new custom field for JSON data that is rendered using Handlebars when included in an email
-
-## 1.16.0 2016-08-29
-
- * Render list values using Handlebars templates
- * Added new API method to create custom fields
- * Added LDAP authentication support
-
-## 1.15.0 2016-07-28
-
- * Check SMTP settings using AJAX instead of posting entire form
-
-## 1.14.0 2016-07-09
-
- * Fixed ANY match segments with range queries
- * Added an option to disable un/subscribe confirmation messages
- * Added support for throttling when sending messages
- * Added preview links in message lists
-
-## 1.13.0 2016-06-23
-
- * Added API method to delete subscribers
- * Added a counter to triggers with a view to list all subscribers that caused this trigger to fire
-
-## 1.12.1 2016-06-23
-
- * Fixed invalid base SQL dump
-
-## 1.12.0 2016-06-22
-
- * Automation support. Create triggers that send a campaign once fired
- * Fixed an issue with unresolved URL redirects
- * Added support for relative date ranges in segments
-
-## 1.11.0 2016-05-31
-
- * Retry transactional mail if failed with soft error (4xx)
- * New feature to preview campaigns using selected test users
-
-## 1.10.1 2016-05-26
-
- * Fix a bug with SMTP transport instance where campaign sending stalled until server was restarted
-
-## 1.10.0 2016-05-25
-
- * Fetch multiple unsent messages at once to speed up delivery
- * Fixed a bug of counting unsubscribers correctly
- * Use LONGTEXT for template text fields (messages might include inlined images which are larger than 64kB)
-
-## 1.9.0 2016-05-16
-
- * New look
- * Added views for bounced/unsubscribed/complained etc.
-
-## 1.8.2 2016-05-13
-
- * Added missing views for subscribers who clicked on any link and subscribers who opened the message
-
-## 1.8.1 2016-05-13
-
- * Fixed an issue in API
-
-## 1.8.0 2016-05-13
-
- * Show details about subscribers who clicked on a specific link
-
-## 1.7.0 2016-05-11
-
- * Updated API, added new option **REQUIRE_CONFIRMATION** for subscriptions to send confirmation email before subscribing
-
-## 1.6.0 2016-05-07
-
- * Added simple API support for adding and removing list subscriptions
-
-## 1.5.0 2016-05-05
-
- * Fixed a bug in unsubscribing through the admin interface
- * Added individual link click stats
-
-## 1.4.1 2016-05-04
-
- * Added support for RSS templates
-
-## 1.4.0 2016-05-04
-
- * Added support for RSS campaigns
- * Subscribers get timezone attached to their profile
- * Outgoing messages are preprocessed using juice
- * Added installation script for easier setup
-
-## 1.3.0 2016-04-29
-
- * Added option to use an URL as message source (when message needs to be rendered a POST request with Merge Tags as the POST body is made against that URL)
- * Added option to schedule sending. You can set optional delay time when starting campaign sending. Once this time is reached sending starts automatically
- * Show meaningful MySQL error when connection fails
-
-## 1.2.0 2016-04-25
-
- * Rewrite merge tags in links (allows using links like `http://example.com/?u=[FIRST_NAME]` in messages)
- * Added view for Imports to list failed addresses
- * Automatic SQL table creation on initial run (no need for the `mysql` command anymore)
- * Automatic SQL table updates on startup
- * Send welcome and unsubscribe confirmation emails for subscribers
- * Added support for GPG encryption for outgoing messages (requires custom field "GPG Key" set up for the list)
- * Added new SMTP option: allow self-signed certs
- * Added new setting: Disable WYSIWG editor (allows better handling of complex HTML templates)
- * Allow downgrading user when server started as root (user is downgraded once all ports are bound)
- * Added Nitrous.io one-click install button for easy try-out
- * Added Max Post Size option to allow larger payloads from bounce webhooks
- * Added VERP support to catch bounces using built in VERP smtp-server (disabled by default)
+ * This is a complete rewrite of Mailtrain v1 with many features added. Just check it out.
diff --git a/Dockerfile b/Dockerfile
index fcbd6fd0..1dd7af3e 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -44,4 +44,4 @@ RUN set -ex; \
COPY --from=builder /app/ /app/
EXPOSE 3000 3003 3004
-ENTRYPOINT ["bash", "/app/docker-entrypoint.sh"]
\ No newline at end of file
+ENTRYPOINT ["bash", "/app/docker-entrypoint.sh"]
diff --git a/Dockerfile-Develop b/Dockerfile-Develop
new file mode 100644
index 00000000..23a536c4
--- /dev/null
+++ b/Dockerfile-Develop
@@ -0,0 +1,14 @@
+# Final Develop Image
+FROM node:10-alpine
+
+WORKDIR /app/
+
+# Install system dependencies
+RUN set -ex; \
+ apk add --update --no-cache \
+ make gcc g++ git python pwgen netcat-openbsd bash imagemagick
+
+EXPOSE 3000 3003 3004
+
+# Keep container running, so you can access it
+CMD tail -f /dev/null
\ No newline at end of file
diff --git a/Gruntfile.js b/Gruntfile.js
deleted file mode 100644
index 797686e6..00000000
--- a/Gruntfile.js
+++ /dev/null
@@ -1,36 +0,0 @@
-'use strict';
-
-module.exports = function (grunt) {
-
- // Project configuration.
- grunt.initConfig({
- eslint: {
- all: ['lib/**/*.js', 'test/**/*.js', 'config/**/*.js', 'services/**/*.js', 'Gruntfile.js', 'app.js', 'index.js', 'routes/editorapi.js']
- },
-
- nodeunit: {
- all: ['test/nodeunit/**/*-test.js']
- },
-
- jsxgettext: {
- test: {
- files: [{
- src: ['views/**/*.hbs', 'lib/**/*.js', 'routes/**/*.js', 'services/**/*.js', 'app.js', 'index.js', '!ignored'],
- output: 'mailtrain.pot',
- 'output-dir': './languages/'
- }],
- options: {
- keyword: ['translate', '_']
- }
- }
- }
- });
-
- // Load the plugin(s)
- grunt.loadNpmTasks('grunt-eslint');
- grunt.loadNpmTasks('grunt-contrib-nodeunit');
- grunt.task.loadTasks('tasks');
-
- // Tasks
- grunt.registerTask('default', ['eslint', 'nodeunit', 'jsxgettext']);
-};
diff --git a/README.md b/README.md
index aed0e107..a427fb6e 100644
--- a/README.md
+++ b/README.md
@@ -1,64 +1,283 @@
-## Mailtrain v2 beta is available. Check it out here https://github.com/Mailtrain-org/mailtrain/tree/development
+# Mailtrain v2 (beta)
-# Mailtrain
+Mailtrain is a self hosted newsletter application built on Node.js (v10+) and MySQL (v8+) or MariaDB (v10+).
-[Mailtrain](http://mailtrain.org) is a self hosted newsletter application built on Node.js (v7+) and MySQL (v5.5+ or MariaDB).
-
-
+
## Features
-* Subscriber list management
+* Subscriber lists management
* List segmentation
* Custom fields
-* Email templates
-* Large CSV list import files
+* Email templates (including MJML-based templates)
+* Custom reports
+* Automation (triggered and RSS campaigns)
+* Multiple users with granular user permissions and flexible sharing
+* Hierarchical namespaces for enterprise-level situations
+* Builtin Zone-MTA (https://github.com/zone-eu/zone-mta) for close-to-zero setup of mail delivery
-Subscribe to Mailtrain Newsletter [here](https://mailtrain.org/subscription/S18sew2wM) (uses Mailtrain obviously)
+## Recommended minimal hardware Requirements
+* 2 vCPU
+* 4096 MB RAM
-## Hardware Requirements
-* 1 vCPU
-* 1024 MB RAM
-## Quick Start - Deploy with Docker
-#### Requirements:
+## Quick Start
- * [Docker](https://www.docker.com/)
- * [Docker Compose](https://docs.docker.com/compose/)
+### Preparation
+Mailtrain creates three URL endpoints, which are referred to as "trusted", "sandbox" and "public". This allows Mailtrain
+to guarantee security and avoid XSS attacks in the multi-user settings. The function of these three endpoints is as follows:
+- *trusted* - This is the main endpoint for the UI that a logged-in user uses to manage lists, send campaigns, etc.
+- *sandbox* - This is an endpoint not directly visible to a user. It is used to host WYSIWYG template editors.
+- *public* - This is an endpoint for subscribers. It is used to host subscription management forms, files and archive.
-#### Steps:
-Depending on how you have configured your system and Docker you may need to prepend the commands below with `sudo`.
+The recommended deployment of Mailtrain would use 3 DNS entries that all points to the **same** IP address. For example as follows:
+- *lists.example.com* - public endpoint (A record `lists` under `example.com` domain)
+- *mailtrain.example.com* - trusted endpoint (CNAME record `mailtrain` under `example.com` domain that points to `lists`)
+- *sbox.mailtrain.example.com* - sandbox endpoint (CNAME record `sbox.mailtrain` under `example.com` domain that points to `lists`)
-* 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, especially replace the value in `Service Address (URL)` from `localhost` to the actual IP or domain if installed on a server, otherwise e.g. image upload will not work.
-* 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)
+### Installation on fresh CentOS 7 or Ubuntu 18.04 LTS (public website secured by SSL)
-### 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
+This will setup a publicly accessible Mailtrain instance. All endpoints (trusted, sandbox, public) will provide both HTTP (on port 80)
+and HTTPS (on port 443). The HTTP ports just issue HTTP redirect to their HTTPS counterparts.
- 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, especially replace the value in `Service Address (URL)` from `localhost` to the actual IP or domain if installed on a server, otherwise e.g. image upload will not work.
- 8. Navigate to [http://localhost:3000/users/account](http://localhost:3000/users/account) and update user information and password
+The script below will also acquire a valid certificate from [Let's Encrypt](https://letsencrypt.org/).
+If you are hosting Mailtrain on AWS or some other cloud provider, make sure that **before** running the installation
+script you allow inbound connection to ports 80 (HTTP) and 443 (HTTPS).
-## Read The Docs
-For more information, please [read the docs](http://docs.mailtrain.org/).
+**Note,** that this will automatically accept the Let's Encrypt's Terms of Service.
+Thus, by running this script below, you agree with the Let's Encrypt's Terms of Service (https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
+
+
+
+1. Login as root. (I had some problems running npm as root on CentOS 7 on AWS. This seems to be fixed by the seemingly extraneous `su` within `sudo`.)
+ ```
+ sudo su -
+ ```
+
+2. Install GIT
+
+ For Centos 7 type:
+ ```
+ yum install -y git
+ ```
+
+ For Ubuntu 18.04 LTS type
+ ```
+ apt-get install -y git
+ ```
+
+3. Download Mailtrain using git to the `/opt/mailtrain` directory
+ ```
+ cd /opt
+ git clone https://github.com/Mailtrain-org/mailtrain.git
+ cd mailtrain
+ git checkout development
+ ```
+
+4. Run the installation script. Replace the urls and your email address with the correct values. **NOTE** that running this script you agree
+ Let's Encrypt's conditions.
+
+ For Centos 7 type:
+ ```
+ bash setup/install-centos7-https.sh mailtrain.example.com sbox.mailtrain.example.com lists.example.com admin@example.com
+ ```
+
+ For Ubuntu 18.04 LTS type:
+ ```
+ bash setup/install-ubuntu1804-https.sh mailtrain.example.com sbox.mailtrain.example.com lists.example.com admin@example.com
+ ```
+
+5. Start Mailtrain and enable to be started by default when your server starts.
+ ```
+ systemctl start mailtrain
+ systemctl enable mailtrain
+ ```
+
+6. Open the trusted endpoint (like `https://mailtrain.example.com`)
+
+7. Authenticate as `admin`:`test`
+
+8. Update your password under admin/Account
+
+9. Update your settings under Administration/Global Settings.
+
+10. If you intend to sign your email by DKIM, set the DKIM key and DKIM selector under Administration/Send Configurations.
+
+
+### Installation on fresh CentOS 7 or Ubuntu 18.04 LTS (local installation)
+
+This will setup a locally accessible Mailtrain instance (primarily for development and testing).
+All endpoints (trusted, sandbox, public) will provide only HTTP as follows:
+- http://localhost:3000 - trusted endpoint
+- http://localhost:3003 - sandbox endpoint
+- http://localhost:3004 - public endpoint
+
+1. Login as root. (I had some problems running npm as root on CentOS 7 on AWS. This seems to be fixed by the seemingly extraneous `su` within `sudo`.)
+ ```
+ sudo su -
+ ```
+
+2. Install git
+
+ For Centos 7 type:
+ ```
+ yum install -y git
+ ```
+
+ For Ubuntu 18.04 LTS type:
+ ```
+ apt-get install -y git
+ ```
+
+3. Download Mailtrain using git to the `/opt/mailtrain` directory
+ ```
+ cd /opt
+ git clone https://github.com/Mailtrain-org/mailtrain.git
+ cd mailtrain
+ git checkout development
+ ```
+
+4. Run the installation script. Replace the urls and your email address with the correct values. **NOTE** that running this script you agree
+ Let's Encrypt's conditions.
+
+ For Centos 7 type:
+ ```
+ bash setup/install-centos7-local.sh
+ ```
+
+ For Ubuntu 18.04 LTS type:
+ ```
+ bash setup/install-ubuntu1804-local.sh
+ ```
+
+5. Start Mailtrain and enable to be started by default when your server starts.
+ ```
+ systemctl start mailtrain
+ systemctl enable mailtrain
+ ```
+
+6. Open the trusted endpoint http://localhost:3000
+
+7. Authenticate as `admin`:`test`
+
+
+
+### Deployment with Docker and Docker compose
+
+This setup starts a stack composed of Mailtrain, MongoDB, Redis, and MariaDB. It will setup a locally accessible Mailtrain instance with HTTP endpoints as follows.
+- http://localhost:3000 - trusted endpoint
+- http://localhost:3003 - sandbox endpoint
+- http://localhost:3004 - public endpoint
+
+To make this publicly accessible, you should add reverse proxy that makes these endpoints publicly available over HTTPS. If using the proxy, you also need to set the URL bases and `--withProxy` parameter via `MAILTRAIN_SETTING` as shown below.
+An example of such proxy would be:
+- http://localhost:3000 -> https://mailtrain.example.com
+- http://localhost:3003 -> https://sbox.mailtrain.example.com
+- http://localhost:3004 -> https://lists.example.com
+
+To deploy Mailtrain with Docker, you need the following two dependencies installed:
+
+- [Docker](https://www.docker.com/)
+- [Docker Compose](https://docs.docker.com/compose/)
+
+These are the steps to start Mailtrain via docker-compose:
+
+1. Download Mailtrain's docker-compose build file
+ ```
+ curl -O https://raw.githubusercontent.com/Mailtrain-org/mailtrain/development/docker-compose.yml
+ ```
+
+2. Deploy Mailtrain via docker-compose (in the directory to which you downloaded the `docker-compose.yml` file). This will take quite some time when run for the first time. Subsequent executions will be fast.
+ ```
+ docker-compose up
+ ```
+
+3. Open the trusted endpoint http://localhost:3000
+
+4. Authenticate as `admin`:`test`
+
+The instructions above use an automatically built Docker image on DockerHub (https://hub.docker.com/r/mailtrain/mailtrain). If you want to build the Docker image yourself (e.g. when doing development), use the `docker-compose-local.yml` located in the project's root directory.
+
+
+### Deployment with Docker and Docker compose (for development)
+This setup starts a stack like above, but is tweaked to be used for local development using docker containers.
+
+1. Clone this repository
+
+2. Bring up the development stack
+ ```
+ docker-compose -f docker-compose-develop.yml up -d
+ ```
+3. Connect to a shell inside the container
+ ```
+ docker-compose exec mailtrain bash
+ ```
+4. Run these commands once to install all the node modules and build the client webapp
+ ```
+ cd /app
+ bash setup/reinstall-modules.sh
+ cd /app/client && npm run build && cd /app
+
+5. Start the server for the first time with this command, to generate the `server/config/production.yaml`
+ ```
+ bash docker-entrypoint.sh
+ ```
+
+
+### Docker Environment Variables
+When using Docker, you can override the default Mailtrain settings via the following environment variables. These variables have to be defined in the docker-compose config
+file. You can give them a value directly in the `docker-compose.yml` config file.
+
+Alternatively, you can just declare them there leaving their value empty
+(see https://docs.docker.com/compose/environment-variables/#pass-environment-variables-to-containers). In that case, the
+value can be provided via a file called `.env` or via environment
+variables (e.g. `URL_BASE_TRUSTED=https://mailtrain.domain.com (and more env-vars..) docker-compose -f docker-compose.yml build (or up)`)
+
+| Parameter | Description |
+| --------- | ----------- |
+| PORT_TRUSTED | sets the trusted port of the instance (default: 3000) |
+| PORT_SANDBOX | sets the sandbox port of the instance (default: 3003) |
+| PORT_PUBLIC | sets the public port of the instance (default: 3004) |
+| URL_BASE_TRUSTED | sets the trusted url of the instance (default: http://localhost:3000) |
+| URL_BASE_SANDBOX | sets the sandbox url of the instance (default: http://localhost:3003) |
+| URL_BASE_PUBLIC | sets the public url of the instance (default: http://localhost:3004) |
+| WWW_HOST | sets the address that the server binds to (default: 0.0.0.0) |
+| WWW_PROXY | use if Mailtrain is behind an http reverse proxy (default: false) |
+| WWW_SECRET | sets the secret for the express session (default: `$(pwgen -1)`) |
+| MONGO_HOST | sets mongo host (default: mongo) |
+| WITH_REDIS | enables or disables redis (default: true) |
+| REDIS_HOST | sets redis host (default: redis) |
+| MYSQL_HOST | sets mysql host (default: mysql) |
+| MYSQL_DATABASE | sets mysql database (default: mailtrain) |
+| MYSQL_USER | sets mysql user (default: mailtrain) |
+| MYSQL_PASSWORD | sets mysql password (default: mailtrain) |
+| WITH_LDAP | use if you want to enable LDAP authentication |
+| LDAP_HOST | LDAP Host for authentication (default: ldap) |
+| LDAP_PORT | LDAP port (default: 389) |
+| LDAP_SECURE | use if you want to use LDAP with ldaps protocol |
+| LDAP_BIND_USER | User for LDAP connexion |
+| LDAP_BIND_PASS | Password for LDAP connexion |
+| LDAP_FILTER | LDAP filter |
+| LDAP_BASEDN | LDAP base DN |
+| LDAP_UIDTAG | LDAP UID tag (e.g. uid/cn/username) |
+| WITH_ZONE_MTA | enables or disables builtin Zone-MTA (default: true) |
+| POOL_NAME | sets builtin Zone-MTA pool name (default: os.hostname()) |
+| LOG_LEVEL | sets log level among `silly|verbose|info|http|warn|error|silent` (default: `info`) |
+
+If you don't want to modify the original `docker-compose.yml`, you can put your overrides to another file (e.g. `docker-compose.override.yml`) -- like the one below.
+
+```
+version: '3'
+services:
+ mailtrain:
+ environment:
+ - URL_BASE_TRUSTED
+ - URL_BASE_SANDBOX
+ - URL_BASE_PUBLIC
+```
## 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**
+ **GPL-V3.0**
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 00000000..82f5c76f
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,26 @@
+Note that some of these may be already obsolete...
+
+### Front page
+- Some dashboard
+
+### Campaigns
+- List of sent RSS campaigns (?)
+
+### Pull requests
+- Support ldaps:// - 5325f2ea7864ce5f42a9a6df3408af7ffbd32591
+- Support https - abd788d8f4d18b5a977226ba1224cba7f2b7fa9b
+- Support warn of failed login - 4bd1e994b27420ba366d9b0429e9014e5bf01f13
+- Add X-Mailer header option in settings to override or disable it - 44fe8882b876bdfd9990110496d16f819dc64ac3
+- Add custom unsubscribe option in a campaign - 68cb8384f7dfdbcaf2932293ec5a2f1ec0a1554e
+
+### API
+- Add API extensions
+
+### GDPR
+- Refuse editing subscriptions which have been anonymized
+- Add field to subscriptions which says till when the consent has been given
+- Provide a link (and merge tag) that will update the consent date to now
+- Add campaign trigger that triggers if the consent for specific subscription field is about to expire (i.e. it is greater than now - seconds)
+
+### RSS Campaigns
+- Aggregated RSS campaigns
\ No newline at end of file
diff --git a/UPGRADE.md b/UPGRADE.md
new file mode 100644
index 00000000..e98d3d28
--- /dev/null
+++ b/UPGRADE.md
@@ -0,0 +1,21 @@
+## Migration from Mailtrain v1 to Mailtrain v2
+
+The migration should happen almost automatically. There are however the following caveats:
+
+1. Structure of config files (under `config`) has changed at many places. Revisit the default config (`config/default.toml`)
+ and update your configs accordingly.
+
+2. Images uploaded in a template editor (Mosaico, Grapesjs, etc.) need to be manually moved to a new destination (under `client`).
+ For Mosaico, this means to move folders named by a number from `public/mosaico` to `client/static/mosaico`.
+
+3. Directory for custom Mosaico templates has changed from `public/mosaico/templates` to `client/static/mosaico/templates`.
+
+4. Imports are not migrated. If you have any pending imports, complete them before migration to v2.
+
+5. Zone MTA configuration endpoint (webhooks/zone-mta/sender-config) has changed. The send-configuration CID has to be
+ part of the URL - e.g. webhooks/zone-mta/sender-config/system.
+
+6. If there are lists that contain birthday or date fields that were created before
+ commit `bc73a0df0cab9943d726bd12fc1c6f2ff1279aa7` (on Jan 3, 2018), they still have TIMESTAMP data type in DB instead
+ of DATETIME. The problem was that that commit did not introduce migration from TIMESTAMP to DATETIME.
+ Mailtrain v2 does this migration, however in some corner cases, this may shift the date by a day back or forth.
diff --git a/app.js b/app.js
deleted file mode 100644
index c6578e60..00000000
--- a/app.js
+++ /dev/null
@@ -1,265 +0,0 @@
-'use strict';
-
-const config = require('config');
-const log = require('npmlog');
-
-const _ = require('./lib/translate')._;
-
-const express = require('express');
-const bodyParser = require('body-parser');
-const path = require('path');
-const favicon = require('serve-favicon');
-const logger = require('morgan');
-const cookieParser = require('cookie-parser');
-const session = require('express-session');
-const RedisStore = require('connect-redis')(session);
-const flash = require('connect-flash');
-const hbs = require('hbs');
-const handlebarsHelpers = require('./lib/handlebars-helpers');
-const compression = require('compression');
-const passport = require('./lib/passport');
-const tools = require('./lib/tools');
-
-const routes = require('./routes/index');
-const users = require('./routes/users');
-const lists = require('./routes/lists');
-const settings = require('./routes/settings');
-const settingsModel = require('./lib/models/settings');
-const templates = require('./routes/templates');
-const campaigns = require('./routes/campaigns');
-const links = require('./routes/links');
-const fields = require('./routes/fields');
-const forms = require('./routes/forms');
-const segments = require('./routes/segments');
-const triggers = require('./routes/triggers');
-const webhooks = require('./routes/webhooks');
-const subscription = require('./routes/subscription');
-const archive = require('./routes/archive');
-const api = require('./routes/api');
-const blacklist = require('./routes/blacklist');
-const editorapi = require('./routes/editorapi');
-const grapejs = require('./routes/grapejs');
-const mosaico = require('./routes/mosaico');
-const reports = require('./routes/reports');
-const reportsTemplates = require('./routes/report-templates');
-
-const app = express();
-
-// view engine setup
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', 'hbs');
-
-// Handle proxies. Needed to resolve client IP
-if (config.www.proxy) {
- app.set('trust proxy', config.www.proxy);
-}
-
-// Do not expose software used
-app.disable('x-powered-by');
-
-hbs.registerPartials(__dirname + '/views/partials');
-hbs.registerPartials(__dirname + '/views/subscription/partials/');
-hbs.registerPartials(__dirname + '/views/report-templates/partials/');
-hbs.registerPartials(__dirname + '/views/reports/partials/');
-
-/**
- * We need this helper to make sure that we consume flash messages only
- * when we are able to actually display these. Otherwise we might end up
- * in a situation where we consume a flash messages but then comes a redirect
- * and the message is never displayed
- */
-hbs.registerHelper('flash_messages', function () { // eslint-disable-line prefer-arrow-callback
- if (typeof this.flash !== 'function') { // eslint-disable-line no-invalid-this
- return '';
- }
-
- let messages = this.flash(); // eslint-disable-line no-invalid-this
- let response = [];
-
- // group messages by type
- Object.keys(messages).forEach(key => {
- let el = '
+ );
+ }
+}
\ No newline at end of file
diff --git a/client/src/account/API.js b/client/src/account/API.js
new file mode 100644
index 00000000..42636879
--- /dev/null
+++ b/client/src/account/API.js
@@ -0,0 +1,631 @@
+'use strict';
+
+import React, {Component} from 'react';
+import {withTranslation} from '../lib/i18n';
+import {Trans} from 'react-i18next';
+import {requiresAuthenticatedUser, Title, withPageHelpers} from '../lib/page'
+import {withAsyncErrorHandler, withErrorHandling} from '../lib/error-handling';
+import axios from '../lib/axios';
+import {Button} from '../lib/bootstrap-components';
+import {getUrl} from "../lib/urls";
+import {withComponentMixins} from "../lib/decorator-helpers";
+import styles from "./styles.scss"
+
+@withComponentMixins([
+ withTranslation,
+ withErrorHandling,
+ withPageHelpers,
+ requiresAuthenticatedUser
+])
+export default class API extends Component {
+ constructor(props) {
+ super(props);
+
+ this.state = {
+ accessToken: null
+ };
+ }
+
+ @withAsyncErrorHandler
+ async loadAccessToken() {
+ const response = await axios.get(getUrl('rest/access-token'));
+ this.setState({
+ accessToken: response.data
+ });
+ }
+
+ componentDidMount() {
+ // noinspection JSIgnoredPromiseFromCall
+ this.loadAccessToken();
+ }
+
+ async resetAccessToken() {
+ const response = await axios.post(getUrl('rest/access-token-reset'));
+ this.setState({
+ accessToken: response.data
+ });
+ }
+
+ render() {
+ const t = this.props.t;
+
+ const accessToken = this.state.accessToken || 'ACCESS_TOKEN';
+
+ let accessTokenMsg;
+ if (this.state.accessToken) {
+ accessTokenMsg =
{t('personalAccessToken') + ': '}{accessToken}
;
+ } else {
+ accessTokenMsg =
{t('accessTokenNotYetGenerated')}
;
+ }
+
+ return (
+
+ {t('api')}
+
+
+
+
+
+
+ {accessTokenMsg}
+
+
+
+
+
+
{t('notesAboutTheApi')}
+
+
+
+ API response is a JSON structure with error and data properties. If the response error has a value set then the request failed.
+
+
+ You need to define proper Content-Type when making a request. You can either use application/x-www-form-urlencoded for normal form data or application/json for a JSON payload. Using multipart/form-data is not supported.
+