README.md 723 Bytes
Newer Older
1 2
# WEnotes-server

3 4
This is a simple NodeJS-based web and [Faye](http://faye.jcoglan.com)
server used for WEnotes. Its main purpose is to allow WEnotes
5 6 7
clients to subscribe to topics (channels, tags, rooms) of
interest.

Jim Tittsler's avatar
Jim Tittsler committed
8 9 10 11 12 13 14 15
It also serves as a simple proxy to the backing CouchDB server
so that all requests can happen on port 80 (avoiding problems with
networks that filter other ports).

And its simple webserver provides an incoming endpoint for
integrations with [Rocket.Chat](https://rocket.chat) (or
presumably Slack or Mattermost, but those are untested).

16 17 18 19 20 21 22
`server.js` is intended to be run under a supervisor such as
[forever](https://www.npmjs.com/package/forever) or
[pm2](http://pm2.keymetrics.io/).

## License
MIT