Project

General

Profile

QuasselWiki » History » Version 58

seezer, 07/02/2009 08:00 PM
end of tidy time

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 41 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 by combining them into one binary, 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 53 Lingerance
In simpler terms, the "monolithic" client is a response to requests for a client that behaves like every other IRC client.  The monolithic client (GUI) is what makes the connections to the IRC networks.  In normal operation, the client (GUI) connnects to a core, it is completely incapable of connecting to anything else.  The core recieves connections from clients, and makes connections to the IRC networks, it also handles logging (currently everything gets put in the database).
15 5 sph
16 12 sph
17 7 sph
h2. Getting started
18 7 sph
19 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.
20 7 sph
21 12 sph
22 10 sph
h3. Installation
23 10 sph
24 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. 
25 10 sph
26 55 seezer
h3. Specific installation instructions
27 12 sph
28 51 miohtama
* [[Build Quassel on Windows]]
29 52 miohtama
* [[Build Core On Ubuntu]]: Setting up Quassel core from the source code on Ubuntu server
30 56 seezer
31 58 seezer
32 10 sph
h3. Connecting to the core
33 40 sph
34 54 seezer
Before starting the core, you could set up [[Client-Core SSL support|Client-Core SSL encryption]] or have a look at the [[PostgreSQL|PostgreSQL article]] before moving on.
35 54 seezer
All that is completely optional.
36 45 sph
37 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).
38 1 seezer
39 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!
40 1 seezer
41 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]].
42 1 seezer
43 1 seezer
44 15 sph
h3. IRC Configuration
45 15 sph
46 15 sph
Now you have to specify which network(s) Quassel should connect to. First you will have to create an identity.
47 15 sph
48 20 sph
!identity.png!
49 15 sph
50 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.
51 15 sph
52 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.
53 15 sph
54 20 sph
!network.png!
55 15 sph
56 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!
57 5 sph
58 4 pennywise
h2. Manuals
59 39 pennywise
60 25 sph
* [[Manage core users]]
61 1 seezer
* [[Buffer Views]]
62 1 seezer
* [[Quassel Logging]]
63 58 seezer
* [[PostgreSQL]]: Setting up PostgreSQL datbase backend
64 58 seezer
* [[Client-Core SSL support]]: How to encrypt the connection between clients and core
65 50 katastrophe
* more [[Shortcuts]]
66 18 sph
67 57 seezer
h2. Frequently asked questions
68 57 seezer
69 57 seezer
Check the [[FAQ]]
70 57 seezer
71 18 sph
h2. Known issues
72 18 sph
73 18 sph
* DCC chat and file transfers are not yet supported.
74 22 sph
* The core does support multiple users but for now this can only be configured with a [[Manage core users|script]].
75 18 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.
76 30 dalbers
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.
77 42 Datafreak
78 42 Datafreak
h2. Static Builds
79 42 Datafreak
80 42 Datafreak
* "Datafreak's Build for Windows":http://www.datafreak.eu/downloads/windows/quassel-irc/ (required "MSVC Redistributable Package":http://www.microsoft.com/downloads/details.aspx?displaylang=de&FamilyID=32bc1bee-a3f9-4c13-9c99-220b62a191ee)
81 42 Datafreak
* "Phon's Build for Windows":http://phon.name/quassel/ (required "MSVC Redistributable Package":http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=32bc1bee-a3f9-4c13-9c99-220b62a191ee , SSL will not work.)
82 42 Datafreak
* "Datafreak's Build for Linux":http://www.datafreak.eu/downloads/linux/quassel-irc/ (x86)
83 49 katastrophe
* "Jannik's static Core Build for Linux":http://jannik.datenschleuder.net/quassel/nightly/linux/static/amd64/?C=M;O=D (x86_64)
84 48 katastrophe
* "Datafreak's static Core for Mipsel":http://www.datafreak.eu/downloads/linux/quasselcore-mipsel/ (works on "Asus Wl500w":http://www.asus.de/products.aspx?l1=12&l2=43&l3=0&l4=0&model=1277&modelmenu=1)