Installation
- First install the dependencies for your operating system:
- Copy config.py.example to config.py, and edit it to fit your network's setup.
- Run compile.py to "compile the HTML/js/css" (note that warnings are just warnings, you can ignore them!).
- Run run.py (if you get an error about the select reactor being already registered just run it again) -- note run.py has lots of arguments, you can see them with --help.
- Browse to http://yourmachine:9090/
Debian and derivatives (i.e. Ubuntu, Mint)
Install the following packages:- python (must be at least 2.5).
- python-twisted, python-twisted-bin, python-twisted-core, python-twisted-runner, python-twisted-names, python-twisted-mail, python-twisted-words and python-twisted-web (must be at least Twisted 8.2.0).
- python-zope.interface (at least 8.2.0)
- optional SSL support: python-openssl.
- optional Javascript minimisation: openjdk-6.
- optional efficient versioning: git.
python python-twisted python-twisted-bin python-twisted-core python-twisted-runner python-twisted-names python-twisted-mail python-twisted-words python-twisted-web python-zope.interface python-openssl openjdk-6 git
Other UNIX like operating systems, i.e. other Linux distros (bar FreeBSD)
(note you might be able to install some of these via your OS package manager!)- Python (at least version 2.5 but NOT 3.*).
- zope.interface (this is a dependency of Twisted so may not be required if your OS installs it).
- Twisted (at least version 8.2.0).
- optional SSL support: pyOpenSSL.
- optional Javascript minimisation: Java (the JRE is acceptable).
- optional efficient versioning: git.
FreeBSD
qwebirc has a FreeBSD port, in ports/irc/qwebirc, otherwise installation instructions are the same as for generic UNIX.Windows
Make sure you download the packages for your version of Python -- we suggest 32-bit versions of all packages.- Python (at least version 2.5 but NOT 3.*, we suggest 2.7).
- Twisted (at least version 8.2.0).
- zope.interface (if not bundled with Twisted).
- pywin32.
- optional SSL support: pyOpenSSL.
- optional Javascript minimisation: Java.
- optional efficient versioning: git.
