Fixed readme for AjaxIM_v4.0a4.

Esse commit está contido em:
Daniel Howard
2014-10-09 15:31:48 -07:00
commit 7985251207
+21 -32
Ver Arquivo
@@ -10,6 +10,7 @@ community experience.
* Instant communication between connected users * Instant communication between connected users
* Robust backend server built on [Node.js](http://nodejs.org) * Robust backend server built on [Node.js](http://nodejs.org)
* Support for [Socket.IO](http://socket.io), JSON and JSONP
* Can be integrated with virtually any existing website * Can be integrated with virtually any existing website
* Seamless authentication * Seamless authentication
* Works across an entire website, unobtrusively * Works across an entire website, unobtrusively
@@ -20,45 +21,34 @@ community experience.
## Installation ## Installation
Install `Node.js`: Install `Node.js`:
wget http://nodejs.org/dist/v0.8.9/node-v0.8.9-linux-x86.tar.gz
tar xzf node-v0.8.9-linux-x86.tar.gz wget http://nodejs.org/dist/v0.10.32/node-v0.10.32-linux-x86.tar.gz
cd node-v0.8.9 tar xzf node-v0.10.32-linux-x86.tar.gz
cd node-v0.10.32-linux-x86
./configure ./configure
make make
make install make install
Install Node Package Manager (`npm`): Install Ajax IM:
See instructions at http://github.com/isaacs/npm.
Install `Express.js`, `Connect` and `Cookie`: unzip AjaxIM_v4.0a4.zip
npm install express cd AjaxIM_v4.0a4
npm install connect npm install
npm install cookie
Compile the daemon add-on if you plan on letting the server daemonize itself:
cd server/libs/daemon
node-waf configure build
cp build/default/daemon.node .
rm -rf build
## Installation for Development
If you want to test Ajax IM as a standalone app for development, you will need
to install [`Jade`](http://github.com/visionmedia/jade) as well.
To install `Jade`:
npm install jade
## Starting up the server ## Starting up the server
Starting the server in _development_ mode is as simple as: Starting the server in _development_ mode is as simple as:
node server/app.js node server/app.js
To start the server in _production_ mode: To start the server in _production_ mode:
EXPRESS_ENV=production node server/app.js
To start the server as a _daemon_ in _production_ mode: NODE_ENV=production node server/app.js
node server/app.js start production
To start the server using forever with a log file:
npm install forever
forever -l ~/ajaxim.log start ~/AjaxIM_v4.0a4/server/app.js
## Testing it out ## Testing it out
@@ -67,24 +57,23 @@ through the included development testing app. The below instructions are
assuming that you have left all default configuration options. If not, please assuming that you have left all default configuration options. If not, please
replace the host/port values with the correct ones. replace the host/port values with the correct ones.
To get started, first initialize a session cookie by going to: To get started, head over to the development page:
http://localhost:8000/dev/cookie
Then head over to the development page that will initialize the client:
http://localhost:8000/dev/ http://localhost:8000/dev/
That's it! That's it!
## More Information ## More Information
* Follow [endtwist](http://twitter.com/endtwist) on twitter for updates * Follow [ajaximrpg](http://twitter.com/ajaximrpg) on twitter for updates
* [Google Group](http://groups.google.com/group/ajaxim) for discussion * [Google Group](http://groups.google.com/group/ajaxim) for discussion
* [GitHub Wiki](https://github.com/endtwist/AjaxIM/wiki) for guidance * [GitHub Wiki](https://github.com/endtwist/AjaxIM/wiki) for guidance
## Node Compatibility ## Node Compatibility
The `master` branch of Ajax IM is compatible with node --version: The `master` branch of Ajax IM is compatible with node --version:
v0.8.9
v0.10.32
## Contributing ## Contributing
@@ -222,7 +211,7 @@ Methods:
(The MIT License) (The MIT License)
Copyright (c) 2012 [Daniel Howard] (http://www.svexpertise.com) Copyright (c) 2012-2014 [Daniel Howard] (http://www.svexpertise.com)
Copyright (c) 2010 [Joshua Gross](http://www.unwieldy.net) Copyright (c) 2010 [Joshua Gross](http://www.unwieldy.net)
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy