Permalink
Browse files

add LICENSE. Update README with new installation instructions

  • Loading branch information...
1 parent 6e01061 commit c5f6943198f182c2c1c2865c3cc54d66530ffee2 @maccman committed Sep 4, 2010
Showing with 18 additions and 12 deletions.
  1. 0 {client → }/LICENSE
  2. +15 −10 README
  3. +3 −2 client/README
File renamed without changes.
View
@@ -35,36 +35,41 @@ Juggernaut.publish(["channel1", "channel2"], "foo")
## Requirements
+ * Node.js
+ * Redis
+ * Ruby
+
node.js requirements:
* socket.io
* node-static
* redis-client
-Other requirements:
- * redis
- * ruby
- * redis ruby gem (sudo gem install redis)
-
## Installation
* Install node.js - http://nodejs.org/
* Install npm
>> curl http://npmjs.org/install.sh | sudo sh
* Install socket.io
- >> sudo npm install http://github.com/LearnBoost/Socket.IO-node/tarball/master
+ >> sudo npm install socket.io
* Install node-static
>> sudo npm install http://github.com/cloudhead/node-static/tarball/master
* Install redis-client
- >> sudo npm install http://github.com/technoweenie/redis-node-client/tarball/master
- * Install the juggernaut gem
+ >> sudo npm install http://github.com/technoweenie/redis-node-client/tarball/npm
+ * Install Redis - http://code.google.com/p/redis/
+ * Install the Juggernaut gem (optional):
>> sudo gem install juggernaut --pre
## Running
+Start Redis
>> ./redis-server redis.conf
+
+Download Juggernaut, and start the Juggernaut server:
+>> git clone git://github.com/maccman/juggernaut.git
>> cd juggernaut
>> node server.js
->> open http://localhost:8080
+
+That's it! Now go to http://localhost:8080/ to see Juggernaut in action.
Start the server using root if you want Flash support. It needs to open a restricted port.
@@ -75,7 +80,7 @@ http://kevin.vanzonneveld.net/techblog/article/run_nodejs_as_a_service_on_ubuntu
# Scaling
Just create more Juggernaut daemons. Put a TCP load balancer in front of them.
-Make sure they all connect to the same Redis instance.
+Make sure they all connect to the same Redis instance. Use sticky sessions.
## Usage case - Group Chat
View
@@ -1,7 +1,8 @@
= Juggernaut
-Description goes here.
+See http://github.com/maccman/juggernaut
== Copyright
-Copyright (c) 2010 Alex MacCaw. See LICENSE for details.
+Copyright (c) 2010 Alex MacCaw.
+See http://github.com/maccman/juggernaut/blob/master/LICENSE for details.

0 comments on commit c5f6943

Please sign in to comment.