Vorbereitungen¶

MUCkl benutzt XMPP-Gruppenchats als Technik im Hintergrund. Auf dem XMPP-Server müssen deswegen folgende Vorkehrungen getroffen werden:

Installation¶

Als erstes muss man sich das aktuelle Tar-Archiv von der MUCkl-Homepage herunterladen. Da es komplett aus statischen HTML-Seiten und JavaScript-Dateien besteht, die ausschließlich auf dem Client-Rechner interpretiert werden, stellt das keinerlei Gefahr für den Server dar. Selbst wenn man normalerweise gegenüber Software von Drittanbietern eher skeptisch eingestellt ist.

# /etc/apache2/sites-available/muckl

Alias /webchat /usr/local/share/MUCkl-0.4.2

<Directory /usr/local/share/MUCkl-0.4.2>
        AddDefaultCharset UTF-8
</Directory>

ProxyRequests Off
ProxyPass /webchat/http-poll/ http://jabber-server:5280/http-poll/
ProxyPassReverse /webchat/http-poll/ http://jabber-server:5280/http-poll/

<Proxy http://jabber-server:5280/http-poll/*>
        Order deny,allow
        Deny from all
        Allow from all
</Proxy>

sudo a2enmod proxy
sudo a2enmod proxy_http
sudo a2ensite muckl 

MUCkl-Konfiguration¶

Die MUCkl-Konfiguration findet in einer einzigen Datei statt, der config.js im MUCkl-Verzeichnis. Folgende Einstellungen sollte man dabei anpassen:

var BACKENDTYPE = 'polling';
var HTTPBASE = "http-poll/";

Man kann auch HTTP-Binding benutzen, was sogar besser als HTTP-Polling sein soll. Diese Anleitung geht aber davon aus, dass man den ejabberd als XMPP-Server benutzt, der Binding nur über ein kompliziert einzubindendes Zusatzmodul unterstützt. Die Aktivierung von Polling ist einfacher zu bewerkstelligen.

var XMPPDOMAIN = "jabber-server.tld"; // domain name of jabber service to be used
var MUCKLJID = "muckl"; // username
var MUCKLPASS = "n0t_s0_s3cr3t"; // password

Hier muss man den Domain-Namen des XMPP-Servers einstellen, (vollständig - nicht "localhost" o.ä.,) sowie den Namen und das Passwort des vorher angelegten Accounts.

var ROOMS =
[
        {
                name:'testraum',
                description:'Hier eine Kurzbeschreibung eintragen',
                server:'conference.jabber-server.irgendwo',
                // Hier bei Bedarf Pfad zu einem gewünschten Logo eintragen und Kommentarzeichen entfernen:
//              logo: 'http://zeank.darktech.org/spongebob.png'
        }
];

Ein paar Beispielräume sind schon vorkonfiguriert. Diese müssen natürlich angepasst werden. Man kann durchaus mehrere Räume - auch auf unterschiedlichen Servern - eintragen, die dann in einer Auswahlliste zur Verfügung gestellt werden.

var timerval = 500; // poll frequency in msec

Die voreingestellten 5000 Millisekunden Poll-Frequenz führen zu spürbaren Verzögerungen und sollten nur dann belassen so werden, wenn man nur eine sehr knappen Bandbreite zu Verfügung hat.

⚓︎

var XMPPDOMAIN = "anonymous.jabber-server.tld"; // domain name of jabber service to be used

var ANONHOST = "anonymous.jabber-server.tld"; // hostname of sasl anonymous service 

//var MUCKLJID = "muckl"; // username
//var MUCKLPASS = "n0t_s0_s3cr3t"; // password

Benutzung¶

Die Benutzung von MUCkl ist geradezu trivial. Auf der Eingangsseite wird man aufgefordert, einen Nicknamen zu wählen. Außerdem kann man einen Chatraum aus einer Auswahllliste wählen, sofern der Administrator mehrere Räume konfiguriert hat. Noch ein Klick auf "Login" und schon geht es los.

Es öffnet sich die Chat-Oberfläche mit den drei typischen Bereichen für die Darstellung des Chats (links), die Teilnehmerliste (rechts) und die Eingabezeile (unten), die genauso funktioniert, wie man das erwartet und kennt. Worauf man vielleicht nicht auf Anhieb kommt ist, dass man per Klick auf einen Teilnehmer in der Liste auch private Nachrichten an diesen senden kann (wenn der Chatraum XMPP-seitig so konfiguriert wurde, dass das möglich sein soll). Ein erneuter Klick auf den Namen lässt die Eingaben wieder in den öffentlichen Raum gelangen.

Ganz am unteren Rand des Fensters kann man seinen XMPP-Status ändern und eine zugehörige Status-Meldung setzen. Zwei weitere Piktogramme schalten eine eher nervige Klanguntermalung ein bzw. sind für das Verlassen des Chatraums zuständig.

Themes und Lokalisierung¶

Wer das Aussehen oder die Sprache von MUCkl verändern will, kommt um ein wenig Handarbeit nicht herum. Die Datei muckl.css muss dafür verändert bzw. die betreffenden englischsprachigen Bezeichnungen in den HTML- und JavaScript-Dateien gesucht und ersetzt werden.

Links¶

• MUCkl-Homepage 🇬🇧

• MUCkl-Anleitung auf der ejabberd-Community-Seite 🇬🇧

• Konfiguration von anonymen Logins 🇬🇧