= Welcome to Speeqe =



[http://www.speeqe.com Speeqe] is a web based, group chat client that works with the [http://www.xmpp.org/extensions/xep-0045.html XMPP/MUC] protocol. It is chat made simple. The goal is to give the user the best and easiest experience in creating chat rooms.  It is a combination of javascript and python code using a collection of open source software and software tools. This collection is nginx or apache for a frontend. The frontend serves the webclient which is javascript using [http://code.stanziq.com/strophe Strophe] and JQuery. It also proxies to  [http://code.stanziq.com/punjab Punjab] for the [http://www.xmpp.org/extensions/xep-0124.html BOSH] connection to connect to [http://xmpp.org XMPP] based servers. To tie it all together there is a small amount of django. 



= Features =



HTML/javascript client



Themable (all UI is in one html file)



Inline images.



Inline youtube videos.



Kick,ban,unban support.



Room configuration.



DNS named rooms (ie http://speeqers.speeqe.com will go to the room speeqers@chat.speeqe.com)



Ability to connect to federated XMPP servers and chat rooms. 



= Downloads =



== Source code ==



Download the latest code in the Git repository.



{{{

git clone git://code.stanziq.com/speeqe

}}}



NOTE: Installing from Git is not installing something unstable. The master branch will always be stable. For new tickets a branch has to be created and reviewed before merging into master. There will be CodingGuidelines soon.



The master branch is also available for download without git. 



 * http://code.stanziq.com/cgit/speeqe/speeqe/snapshot/speeqe-master.zip

 * http://code.stanziq.com/cgit/speeqe/speeqe/snapshot/speeqe-master.tar.gz

 * http://code.stanziq.com/cgit/speeqe/speeqe/snapshot/speeqe-master.tar.bz2



== Speeqe-based appliance ==



An appliance is a pre-packaged server that allows users to skip manual installation of Speeqe and its dependencies, and instead deploy a self-contained, ready-to-use system that requires little to no setup.



[http://www.turnkeylinux.org/ejabberd TurnKey ejabberd] is a free open source appliance that combines Speeqe with ejabberd. Deploys in minutes on bare metal, a virtual machine or in the cloud. Part of the [http://www.turnkeylinux.org TurnKey Linux Virtual Appliance Library].



= Documentation =



SpeeqeSetup

Setting up the full installation of speeqe.



SpeeqeThemes

Documentation on how the speeqe themes work.



SpeeqeSetupJavaScriptOnly

Setup to use only javascript and none of the other requirements.



= Bug Reports, Contributing and Feedback =



Bugs and Feedback can be reported by clicking on [http://code.stanziq.com/speeqe/newticket New Ticket] in the navigation bar above. Please be as detailed as possible when submitting tickets. 



You can also participate in the google group:



http://groups.google.com/group/speeqe



http://groups.google.com/group/speeqe-dev