- First install the dependencies for your operating system:
- Check out/download the code
- Create a virtual environment, activate it and install the python dependencies:
- virtualenv -p python2 venv
- source venv/bin/activate
- pip install -r requirements.txt
- 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.
- Note: each time you run you will need to activate the virtual environment first with:
Or, alternatively:
- /path/to/your/qwebirc-install/venv/bin/python run.py
- Browse to http://yourmachine:9090/
Debian and derivatives (i.e. Ubuntu, Mint)
Install the following packages:
- Debian: python2 python2-dev python3-pip python3-openssl openjdk-11-jre-headless git python3-virtualenv
- (Ubuntu/others may have slightly different package names)
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.7.9 but NOT 3.* -- this version should come with pip)
- 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.7.9 but NOT 3.* -- this version should come with pip).
- pywin32.
- optional SSL support: pyOpenSSL.
- optional Javascript minimisation: Java.
- optional efficient versioning: git.
