Frequently asked questions

General questions

Who is this website aimed at?

This site and the downloads on it aimed at IRC network administrators.
The qwebirc frontend is designed to be used by anyone, if you're just trying to add webchat on your website, type /EMBED inside a
qwebirc instance.

What does qwebirc run on?

The backend should run on anything that supports Python and Twisted, it has been tested on Linux, FreeBSD and Windows (XP and above).
qwebirc is developed for QuakeNet's ircd: snircd; people have reported success on ircu and its derivatives, hyperion, charybdis, ratbox and UltimateIRCd, and in theory it should work on any RFC 1459 compliant ircd.
The frontend is tested on IE6, IE7, IE8, Firefox 3, Opera 10, Safari and Chrome.

How do I get started?

Go to the installation page above.

I get warnings while running compile.py about java or hg, what are these?

If the warnings are about hg not being able to generate an id, or not being able to minify you can ignore them (with some pitfalls)!
Normally qwebirc attempts to extract which version you are running (technically which changeset id), and uses that as part of the filename for the compiled JavaScript in an attempt to stop people having to download stuff that hasn't changed. It also attempts to shrink the size of the JavaScript so it will download faster.

As previously mentioned you can ignore both of these warnings, but if you're seriously looking to deploy qwebirc on a public site you really should install
Java for minification, and Mercurial for version tagging.

I messages about Deprecation, what are these?

You can completely ignore these warnings, they have no effect whatsoever.
qwebirc uses md5 instead of hashlib so it can work on older versions of Python.

How do I set up SSL support?

Install OpenSSL (most UNIX systems have it by default, Shining Light Productions offer a version for Windows) and pyOpenSSL.
You can then pass your PEM encoded certificate and key into run.py using the -C and -k options.

I'm getting errors about dropin.cache.new when I run run.py!

This is because your distro hasn't packaged twisted correctly (c.f. Debian bug report). You can fix it by running twistd --help as root, if that doesn't work try the following:
python -c 'from twisted.plugin import IPlugin, getPlugins; list(getPlugins(IPlugin))'

Port 9090?! I want it to run as a VirtualHost in my existing webserver configuration, how?

First, this is a bad idea, because Apache and most other webservers are not designed for large amounts of long-lived connections (like IRC connections). Conventional threaded or multi-process webservers (like Apache) will not be able to cope with more than a few dozen webchat users without falling over (and mostly likely taking your other websites down at the same time)!
qwebirc uses its own embedded webserver which uses non-blocking multiplexing, and can cope with thousands of users easily, QuakeNet runs qwebirc on its own IP address.

Now if you really want to run qwebirc behind Apache, look at the mod_proxy documentation, but it's a really bad idea!

Administration

How can I see what qwebirc is doing?

You can see basic information in the admin engine, visible at http://yourmachine:yourport/adminengine

Note that by default this is IP limited to 127.0.0.1, this is configurable in config.py (the ADMIN_ENGINE_HOSTS option).