Home

thepug edited this page Jan 4, 2015 · 8 revisions

Welcome to Speeqe

Speeqe is a web based, group chat client that works with the 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 Strophe and JQuery. It also proxies to Punjab for the BOSH connection to connect to XMPP 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.yourdomain.com will go to the room speeqers@chat.yourdomain.com)
  • Ability to connect to federated XMPP servers and chat rooms.

Downloads

Download the latest code in the Git repository.


git clone https://github.com/thepug/Speeqe.git

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.

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.

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 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 Issues in the navigation bar above. Please be as detailed as possible when submitting tickets.

You can also participate in the google group:
Speeqe Google Group
Speeqe Development Google Group