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

Update README.md

Browse source
This commit is contained in:
Andris Reinman 2016-06-02 15:08:04 +03:00
parent 54b1d665de
commit d3693111bc
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -30,7 +30,7 @@ Subscribe to Mailtrain Newsletter [here](http://mailtrain.org/subscription/EysIv
### Automatic install (Ubuntu) ### Automatic install (Ubuntu)
You can download and run [install.sh](setup/install.sh) in your blank Ubuntu VPS to set up You can download and run [install.sh](setup/install.sh) in your blank Ubuntu VPS to set up
Mailtrain and all required dependencies (including MySQL). Mailtrain and all required dependencies (including MySQL). The installation script assumes a somewhat blank server, so if this is a machine you are already using for something else, you might want to skip the automatic install and proceed manually.
If you like living on the edge and feel adventurous you can run the installation script directly from your command line as root: If you like living on the edge and feel adventurous you can run the installation script directly from your command line as root:
@ -38,6 +38,16 @@ If you like living on the edge and feel adventurous you can run the installation
curl https://raw.githubusercontent.com/andris9/mailtrain/master/setup/install.sh | sudo bash curl https://raw.githubusercontent.com/andris9/mailtrain/master/setup/install.sh | sudo bash
``` ```
Install script installs and sets up the following:
* **Node.js** (version 6.x)
* **MySQL** (platform default)
* **Mailtrain** (from the master branch) on port 80
* **UFW** firewall that blocks everything besides ports 22, 25, 80, 443
* **Redis** server for session cache
* **logrotate** to rotate Mailtrain log files
* **upstart** or **systemd** init script to automatically start and manage Mailtrain process
If you are using DigitalOcean then you can copy the contents of the [installation script](setup/install.sh) to the User Data textarea field when creating a new VPS (select Ubuntu 14.04 as the droplet Distribution image). After your droplet is created it should already have Mailtrain up and running. Navigate to http://droplet-hostname-or-ip/ and authenticate as `admin`:`test`. Do not forget to update your account information and set up SMTP settings. If you are using DigitalOcean then you can copy the contents of the [installation script](setup/install.sh) to the User Data textarea field when creating a new VPS (select Ubuntu 14.04 as the droplet Distribution image). After your droplet is created it should already have Mailtrain up and running. Navigate to http://droplet-hostname-or-ip/ and authenticate as `admin`:`test`. Do not forget to update your account information and set up SMTP settings.
### Manual (any OS that supports Node.js) ### Manual (any OS that supports Node.js)