jqRealtime

an Erlang realtime http server (MySQL, Mochiweb & Erlang). This project is open-source (GNU AGPL), so you can use it freely.

What for ?

• jqRealtime could be usefull for realtime web applications. It's just a basic "gateway" which dispatch data.

• You can create your own (web) applications, in the language of your choice, and build online chat, collaborative work tools, and so on...

How to Install ?

• Install Erlang OTP on your computer (download a version from http://www.erlang.org/), like R16B.

• Compile and install Erlang OTP :

wget http://www.erlang.org/download/otp_src_R16B.tar.gz
tar -zxpvf otp_src_R16B.tar.gz
cd otp_src_R16B
./configure

• At this step (./configure), check if all dependencies are satisfied, then make & make install erlang :

make
make install

• Now erlang should be located in /usr/bin/local, you can open the erlang console by typing in your shell :

erl

• Set up the database (you'll find the SQL schema at docs/schema.sql)

• Configure the database credentials in src/jqrealtime_web.erl :

%% MySQL Configuration
-define(MYSQL_SERVER, "localhost").
-define(MYSQL_USER, "root").
-define(MYSQL_PASSWD, "").
-define(MYSQL_TABLE, "jqrealtime").
-define(MYSQL_PORT, 3306).

• Now make jqRealtime (dependencies (Mochiweb & Emysql) will be automatically downloaded & compiled) :

make
  ==> jqrealtime (get-deps)
  Pulling mochiweb from {git,"git://github.com/mochi/mochiweb.git",
                             {branch,"master"}}
  Cloning into 'mochiweb'...
  Pulling emysql from {git,"git://github.com/Eonblast/Emysql.git",
                           {branch,"master"}}
  Cloning into 'emysql'...
  ==> mochiweb (get-deps)
  ==> emysql (get-deps)
  ...
  ... etc

• You can now start the webserver with start-dev.sh (or use start-daemon.sh to detach it from console)

./start-dev.sh

• Your webserver homepage is at http://localhost:8080/, but you can configure the port or the IP in src/jqrealtime_sup.erl

Using jqRealtime

• You can push data to a user by calling the pull controller (method POST). Here a basic example with a "Hello World" :

curl -X POST \
          -d "uid=1&data=%7B%22message%22%20%3A%20%22Hello%20World%22%7D" \
          http://localhost:8080/push

• You can secure the pull controller by setting a secret key in jqrealtime_poller.erl (highly recommended) | add token=YOUR_SECRET_KEY in the post parameters

• Important : You have to set a cookie named "jqr", and declare it's value in the table sessions, with a user ID.

Examples

• Check the "examples" directory. There is a working PHP example with jQuery. You can adapt this example for your own projects.

Notes

• jqRealtime allows a user to have multiple sessions (cookies), or multiple tabs opened on his browser. If you broadcast a message to a user, he will receive it everywhere.

TODO

• Todo here :)