Project

General

Profile

QuasselWiki » History » Version 28

sph, 01/18/2009 07:28 PM

1 5 sph
h1. Quassel
2 1 seezer
3 12 sph
{{toc}}
4 12 sph
5 12 sph
6 12 sph
7 5 sph
h2. Introduction
8 5 sph
9 24 sph
Quassel is a program to connect to an IRC network. It has the unique ability to split the graphical component (quasselclient) from the part that handles the IRC connection (quasselcore). This means that you can have a remote core permanently connected to one or more IRC networks and attach a client from wherever you are without moving around any information or settings. However, Quassel can easily behave like any other client, which is referred to as "Quassel Mono".
10 5 sph
11 5 sph
Quassel's distributed approach:
12 20 sph
!distributed.png!
13 5 sph
14 5 sph
15 12 sph
16 7 sph
h2. Getting started
17 7 sph
18 10 sph
Setting up Quassel is fairly easy and straightforward. Since we have a separated core and client, we will configure them in two steps. If you are using the Quassel Mono version, then you can skip the core part as this is done internally.
19 7 sph
20 12 sph
21 10 sph
h3. Installation
22 10 sph
23 10 sph
The best and most reliable way is to simply install the packages provided by your distribution. However, we do offer some static binaries at http://quassel-irc.org/downloads along with Git instructions for those who prefer to compile Quassel themselves. 
24 10 sph
25 12 sph
26 10 sph
h3. Connecting to the core
27 1 seezer
28 28 sph
If you wish to setup an SSL connection between the core and client, you must have a core compiled with the "-DWITH_OPENSSL=ON" cmake option. Generate a key with the following command on the server running the core:
29 14 sph
<pre>openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout ~/.quassel/quasselCert.pem -out ~/.quassel/quasselCert.pem</pre>
30 14 sph
Note that the "~/.quassel/" directory may differ if the --datadir option was specified for quasselcore.
31 1 seezer
32 14 sph
Now start the core and launch quasselclient on your local machine. A connection dialog will show up. Enter the IP address or hostname of the server running the core, enter the port number used by the core and select SSL if applicable. You can also specify a proxy but note that domain names will still be resolved locally (see "Qt4.4":http://doc.trolltech.com/4.4/qnetworkproxy.html#socks5).
33 1 seezer
34 15 sph
During the first connection, you will be guided through a graphical wizard to configure the core properly. Enter a username and password, this will be the administrator. Next, select a database backend (for now this is SQLite only). Click finish and your core is ready!
35 1 seezer
36 27 sph
A configuration screen for adding new users and managing existing ones is under developement, but for the time being you can use a simple [[Manage core users|python script]].
37 1 seezer
38 1 seezer
39 15 sph
h3. IRC Configuration
40 15 sph
41 15 sph
Now you have to specify which network(s) Quassel should connect to. First you will have to create an identity.
42 15 sph
43 20 sph
!identity.png!
44 15 sph
45 16 sph
Set a real name (which doesn't actually have to be real) and add the nicknames you want to use. If the first nickname is not available, the second one (if specified) will be used instead. Change the other settings if you like, this is optional however.
46 15 sph
47 19 sph
After creating an identity, you have to define the IRC network(s) along with the servers they use. If Quassel was installed properly, there should be a preconfigured list of the most popular networks already.
48 15 sph
49 20 sph
!network.png!
50 15 sph
51 23 sph
Make sure you select the identity you just created (which should be the default). Click OK and you're done. Feel free to visit us in the #quassel channel on Freenode!
52 12 sph
53 26 sph
h2. Manuals
54 5 sph
55 4 pennywise
* [[Manage core users]]
56 4 pennywise
* [[Add SSL to the core]]
57 25 sph
* [[Build Quassel on Windows]]
58 18 sph
59 18 sph
h2. Known issues
60 18 sph
61 21 sph
* DCC chat and file transfers are not yet supported.
62 18 sph
* The core does support multiple users but for now this can only be configured with a [[Manage core users|script]].
63 22 sph
* There has been a client for mobile devices but as the codebase updated so quickly it has become outdated and incompatible with newer cores.
64 18 sph
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.