public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #16 from andris9/v1.1

Browse source 
V1.1
This commit is contained in:
Andris Reinman 2016-04-11 21:35:48 -07:00
commit b3164f0867
30 changed files with 520 additions and 209 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -31,7 +31,7 @@ Subscribe to Mailtrain Newsletter [here](http://mailtrain.org/subscription/EysIv
1. Download and unpack Mailtrain [sources](https://github.com/andris9/mailtrain/archive/master.zip)
2. Run `npm install` in the Mailtrain folder to install required dependencies
3. Copy [config/default.toml](config/default.toml) as `config/production.toml` and update MySQL Settings in it
3. Copy [config/default.toml](config/default.toml) as `config/production.toml` and update MySQL settings in it
4. Import SQL tables by running `mysql -u MYSQL_USER -p MYSQL_DB < setup/mailtrain.sql`
5. Run the server `NODE_ENV=production npm start`
6. Open [http://localhost:3000/](http://localhost:3000/)
@ -39,6 +39,25 @@ Subscribe to Mailtrain Newsletter [here](http://mailtrain.org/subscription/EysIv
8. Navigate to [http://localhost:3000/settings](http://localhost:3000/settings) and update service configuration
9. Navigate to [http://localhost:3000/users/account](http://localhost:3000/users/account) and update user information and password
## Using environment variables
Some servers expose custom port and hostname options through environment variables. To support these, create a new configuration file `config/local.js`:
```
module.exports = {
www: {
port: process.env.OPENSHIFT_NODEJS_PORT,
host: process.env.OPENSHIFT_NODEJS_IP
}
};
```
Mailtrain uses [node-config](https://github.com/lorenwest/node-config) for configuration management and thus the config files are loaded in the following order:
1. default.toml
2. {NODE_ENV}.toml (eg. development.toml or production.toml)
3. local.js
### Running behind Nginx proxy
Edit [mailtrain.nginx](setup/mailtrain.nginx) (update `server_name` directive) and copy it to `/etc/nginx/sites-enabled`
@ -56,6 +75,8 @@ Mailtrain uses webhooks integration to detect bounces and spam complaints. Curre
* **SendGrid** – use `http://domain/webhooks/sendgrid` as the webhook URL for bounces and complaints
* **Mailgun** – use `http://domain/webhooks/mailgun` as the webhook URL for bounces and complaints
Additionally Mailtrain (v1.1+) is able to use VERP-based bounce handling. This would require to have a compatible SMTP relay (the services mentioned above strip out or block VERP addresses in the SMTP envelope) and you also need to set up special MX DNS name that points to your Mailtrain installation server.
## License
**GPL-V3.0**