Project

General

Profile

QuasselWiki » History » Version 100

gry, 01/04/2014 02:26 AM
clarify

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 85 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 62 m4yer
13 20 sph
!distributed.png!
14 5 sph
15 85 sph
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) connects to a core, it is completely incapable of connecting to anything else.  The core receives connections from clients, and makes connections to the IRC networks, it also handles logging (currently everything gets put in the database).
16 5 sph
17 12 sph
18 7 sph
h2. Getting started
19 7 sph
20 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.
21 7 sph
22 12 sph
23 10 sph
h3. Installation
24 10 sph
25 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. 
26 10 sph
27 55 seezer
h3. Specific installation instructions
28 12 sph
29 70 seezer
* [[Build Quassel on Windows]] (with Visual Studio)
30 70 seezer
* [[Build Quassel on Windows Mingw|Build Quassel on Windows]] (with MinGW)
31 64 musca
* [[Build Quassel on Linux (english)]]
32 65 musca
* [[Build Quassel on Linux (deutsch)]]
33 68 dalbers
* [[Build Core On Ubuntu]]: Setting up Quassel core from the source code on Ubuntu server (mostly applies to Debian too)
34 67 miohtama
* [[Building quasselcore on Ubuntu 8.04 Hardy Heron/x64 (old Qt4 libs)]]
35 58 seezer
36 10 sph
h3. Connecting to the core
37 40 sph
38 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.
39 54 seezer
All that is completely optional.
40 45 sph
41 92 javier
42 93 javier
Check if Quassel Core is listening on the right interface and if TCP port 4242 is open in your firewall to allow remote connections to Quassel Core.
43 93 javier
On openSUSE, take a look at the QUASSELCORE_LISTEN line in /etc/sysconfig/quasselcore and go to YaST2 Firewall→allowed services and add "Quassel Core" to the list of allowed services.
44 92 javier
45 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).
46 1 seezer
47 85 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 back-end (for now this is SQLite only). Click finish and your core is ready!
48 1 seezer
49 85 sph
More users can be added by passing command line arguments to the core (see [[Manage core users|Managing core users]]).
50 1 seezer
51 1 seezer
52 15 sph
h3. IRC Configuration
53 15 sph
54 15 sph
Now you have to specify which network(s) Quassel should connect to. First you will have to create an identity.
55 15 sph
56 20 sph
!identity.png!
57 15 sph
58 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.
59 15 sph
60 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.
61 15 sph
62 20 sph
!network.png!
63 15 sph
64 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!
65 5 sph
66 4 pennywise
h2. Manuals
67 39 pennywise
68 85 sph
* [[PostgreSQL]]: Setting up PostgreSQL database back-end
69 85 sph
* [[SQLite]]: Some information about the SQLite back-end
70 82 sph
71 96 ChrisH
* Autostart Quassel Core on:
72 96 ChrisH
** [[Autostart Core on Mac|Mac]]
73 96 ChrisH
** [[QuasselCore As A Service (Windows)|Windows]]
74 82 sph
* [[Blowfish Encryption Manual|Blowfish Encryption]]: Encrypt IRC messages in a channel or in a query
75 82 sph
* [[Quassel Logging|Logging in Quassel]]: Fetching and searching the Quassel logs
76 86 sph
* [[SSH Tunneling]]: How to tunnel the client-core connection over SSH
77 82 sph
* [[Client-Core SSL support|SSL support]]: How to encrypt the connection between clients and core
78 82 sph
* [[Manage core users|User management]]: How to add users to the core
79 82 sph
80 82 sph
* [[Buffer Views]]: Filter your channels to the ones you really need
81 83 sph
* [[Stylesheets]]
82 83 sph
* [[Shortcuts]]
83 82 sph
84 18 sph
85 57 seezer
h2. Frequently asked questions
86 57 seezer
87 57 seezer
Check the [[FAQ]]
88 57 seezer
89 18 sph
h2. Known issues
90 18 sph
91 18 sph
* DCC chat and file transfers are not yet supported.
92 30 dalbers
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.
93 1 seezer
94 70 seezer
h2. Static builds
95 1 seezer
96 78 Datafreak
h3. Linux
97 78 Datafreak
98 78 Datafreak
* "Datafreak's Build for Linux x86":http://www.datafreak.eu/downloads/linux/quassel-irc/ (Core only)
99 85 sph
* "MarcLandis' Build for Linux amd64":http://quassel.marclandis.de/download/git/ (Core only)
100 78 Datafreak
101 99 gry
h4. Mobile
102 100 gry
* "quassel2go (mirror)":http://cdnm.at/~christian/maemo/quassel2go/, "quassel2go":http://talk.maemo.org/showthread.php?t=33647 (original discussion, broken link) — .deb. Poorly maintained, UI was created but it is with the old client protocol bits. If these two are separated, could be easier to maintain.
103 99 gry
* Potential platforms:
104 99 gry
** MER-based (Nemo, Sailfish) — rpm
105 99 gry
** Ubuntu Mobile — .deb
106 99 gry
** Tizen, Firefox OS — HTML + JS (no existing client code)
107 99 gry
108 78 Datafreak
h3. Mac
109 78 Datafreak
110 78 Datafreak
* "m4yer's Builds for Mac OSX":http://m4yer.minad.de/quassel/
111 78 Datafreak
112 78 Datafreak
h3. Windows
113 78 Datafreak
114 97 ChrisH
* None
115 78 Datafreak
116 1 seezer
117 72 johu
h2. Development
118 72 johu
119 90 johu
h3. Manuals
120 90 johu
121 75 johu
* Rules (TODO)
122 87 johu
* [[development_getting_started|Getting started]]
123 87 johu
* [[development_git_patches|Git Patches]]
124 89 johu
* [[development_translations|Translations]]
125 72 johu
126 72 johu
h3. Feature Drafts
127 71 johu
128 1 seezer
* [[Blowfish Encryption]]
129 98 MoleMan
* [[Possible_Scripting_Object]]
130 94 Sputnick
131 94 Sputnick
h3. Technical Documentation
132 94 Sputnick
133 94 Sputnick
* [[doc_quassel_protocols|The Quassel Protocol]]