Merge pull request #63 from djds23/update-readme

Update readme to include redis
This commit is contained in:
Ian Webster 2015-12-30 15:12:53 -08:00
commit 73e4c09b5c

View File

@ -64,7 +64,7 @@ text.send('1119491234567', 'Bonjour!', 'intl', function(err) {
### Usage as a standalone server ### Usage as a standalone server
Textbelt can be run as a standalone server with: `node server/app.js`. Be sure to install dependencies first with `npm install`. 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`.
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.