installation.html

---
layout: default
title: Installation
---
<ul>
  <li>First install the dependencies for your operating system:
    <ul>
      <li><a href="#debian">Debian and derivatives (i.e. Ubuntu, Mint)</a></li>
      <li><a href="#unix">Other Linux distros and other UNIXes (except FreeBSD)</a></li>
      <li><a href="#freebsd">FreeBSD</a></li>
      <li><a href="#windows">Windows</a></li>
    </ul>
  </li>
  <li>Check out/download the code</li>
  <li>Create a virtual environment, activate it and install the python dependencies:
    <ul>
      <li>virtualenv -p python2 venv</li>
      <li>source venv/bin/activate</li>
      <li>pip install -r requirements.txt</li>
    </ul>
  </li>
  <li>Copy config.py.example to config.py, and edit it to fit your network's setup.</li>
  <li>Run compile.py to "compile the HTML/js/css" <a href="faq#warnings">(note that warnings are just warnings, you can ignore them!)</a>.</li>
  <li>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.</li>
  <li>Note: each time you run you will need to activate the virtual environment first with:</li>
  <ul>
      <li>source venv/bin/activate</li>
  </ul>

  Or, alternatively:
    <ul>
      <li><b>/path/to/your/qwebirc-install/</b>venv/bin/python run.py</li>
    </ul>
  </li>
  <li>Browse to http://yourmachine:9090/</li>
</ul>

<hr/>

<a name="debian" />
<h2>Debian and derivatives (i.e. Ubuntu, Mint)</h2>

Install the following packages:

<ul>
<li>Debian: </b>python2 python2-dev python3-pip python3-openssl openjdk-11-jre-headless git python3-virtualenv</b>
<li>(Ubuntu/others may have slightly different package names)</li>
</ul>

<hr/>

<a name="unix" />
<h2>Other UNIX like operating systems, i.e. other Linux distros (bar FreeBSD)</h2>

(note you might be able to install some of these via your OS package manager!)

<ul>
<li><a href="http://python.org/download/">Python</a> (at least version 2.7.9 but NOT 3.* -- this version should come with pip)</li>
<li>optional SSL support: <a href="http://pypi.python.org/pypi/pyOpenSSL">pyOpenSSL</a>.</li>
<li>optional Javascript minimisation: <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java</a> (the JRE is acceptable).</li>
<li>optional efficient versioning: <a href="https://git-scm.com/">git</a>.</li>
</ul>

<hr/>

<a name="freebsd" />
<h2>FreeBSD</h2>

qwebirc has a FreeBSD port, in ports/irc/qwebirc, otherwise installation instructions are the same as for generic UNIX.

<hr/>

<a name="windows" />
<h2>Windows</h2>

<b>Make sure you download the packages for your version of Python -- <b>we suggest 32-bit versions of all packages</b>.</b>

<ul>
<li><a href="http://python.org/download/">Python</a> (at least version 2.7.9 but NOT 3.* -- this version should come with pip).</li>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=78018">pywin32</a>.</li>
<li>optional SSL support: <a href="http://pypi.python.org/pypi/pyOpenSSL">pyOpenSSL</a>.</li>
<li>optional Javascript minimisation: <a href="http://java.com/en/download/index.jsp">Java</a>.</li>
<li>optional efficient versioning: <a href="https://git-scm.com/">git</a>.</li>
</ul>

<hr/>