kerbertools/textbelt
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add mutt to README

Browse Source
This commit is contained in:
Ian Webster 2016-05-26 14:29:06 -07:00
parent 3d758729e5
commit f4396a4cd9
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -66,6 +66,8 @@ text.send('1119491234567', 'Bonjour!', 'intl', function(err) {
Textbelt can be run as a standalone server with: `node server/app.js`. Be sure to install dependencies first with `npm install`. This project also relies on redis. To install redis locally, please see the [redis documentation](http://redis.io/topics/quickstart). Before launching the app, ensure redis is running on port 6379 with `redis-server`. Textbelt can be run as a standalone server with: `node server/app.js`. Be sure to install dependencies first with `npm install`. This project also relies on redis. To install redis locally, please see the [redis documentation](http://redis.io/topics/quickstart). Before launching the app, ensure redis is running on port 6379 with `redis-server`.
Textbelt also depends on a local installation of `mutt`, the email client (http://www.mutt.org/). On Linux (Ubuntu), you can `sudo apt-get install mutt`. On macs, you can `brew install mutt`.
By default, the server listens on port 9090 and is configured to accept traffic from a reverse proxy or load balancer such as nginx. To enable accurate IP rate limiting, the reverse proxy should be configured to set the `X-Real-IP` header. By default, the server listens on port 9090 and is configured to accept traffic from a reverse proxy or load balancer such as nginx. To enable accurate IP rate limiting, the reverse proxy should be configured to set the `X-Real-IP` header.
Don't forget to set `fromAddress` in `lib/text.js` to the email address you want to send from. Don't forget to set `fromAddress` in `lib/text.js` to the email address you want to send from.