Project

General

Profile

QuasselWiki » History » Version 109

gry, 12/21/2014 08:52 AM
added link to [[Roadmap]]

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 103 ChrisH
h3. Core
69 103 ChrisH
* Autostart QuasselCore on:  
70 1 seezer
** [[Autostart Core on Mac|Mac]]
71 1 seezer
** [[QuasselCore As A Service (Windows)|Windows]]
72 103 ChrisH
* Backends
73 103 ChrisH
** [[PostgreSQL]]: Setting up PostgreSQL database back-end
74 103 ChrisH
** [[SQLite]]: Some information about the SQLite back-end
75 103 ChrisH
76 103 ChrisH
h3. Shared
77 1 seezer
* [[Blowfish Encryption Manual|Blowfish Encryption]]: Encrypt IRC messages in a channel or in a query
78 1 seezer
* [[Quassel Logging|Logging in Quassel]]: Fetching and searching the Quassel logs
79 1 seezer
* [[SSH Tunneling]]: How to tunnel the client-core connection over SSH
80 1 seezer
* [[Client-Core SSL support|SSL support]]: How to encrypt the connection between clients and core
81 104 ChrisH
* [[Manage core users|User management]]: How to add users to the core
82 106 ChrisH
* [[Migrating from Monolithic to Client+Core]]: How to migrate from the monolithic client to client + core.
83 1 seezer
84 103 ChrisH
h3. Client  
85 103 ChrisH
* GUI Customization
86 103 ChrisH
** [[Buffer Views|Chat Lists]]: Filter your channels to the ones you really need, or split channels & queries into separate widgets.
87 103 ChrisH
** [[Chat View]]
88 103 ChrisH
*** [[Chat View#hide-events|Hide Events]]: Hide Join, Parts and Quits.
89 105 ChrisH
** [[Stylesheets]]: Advanced theming of the entire client.
90 103 ChrisH
*** [[Stylesheet Gallery]]
91 83 sph
* [[Shortcuts]]
92 108 ChrisH
** [[Customize Icons]]
93 82 sph
94 18 sph
95 57 seezer
h2. Frequently asked questions
96 57 seezer
97 57 seezer
Check the [[FAQ]]
98 57 seezer
99 18 sph
h2. Known issues
100 18 sph
101 18 sph
* DCC chat and file transfers are not yet supported.
102 30 dalbers
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.
103 1 seezer
104 70 seezer
h2. Static builds
105 1 seezer
106 102 gry
See also the [[Mobile]] page.
107 102 gry
108 78 Datafreak
h3. Linux
109 78 Datafreak
110 78 Datafreak
* "Datafreak's Build for Linux x86":http://www.datafreak.eu/downloads/linux/quassel-irc/ (Core only)
111 85 sph
* "MarcLandis' Build for Linux amd64":http://quassel.marclandis.de/download/git/ (Core only)
112 78 Datafreak
113 1 seezer
h3. Mac
114 1 seezer
115 1 seezer
* "m4yer's Builds for Mac OSX":http://m4yer.minad.de/quassel/
116 1 seezer
117 1 seezer
h3. Windows
118 101 gry
119 78 Datafreak
* None
120 1 seezer
121 72 johu
h2. Development
122 72 johu
123 109 gry
[[Roadmap]]
124 109 gry
125 90 johu
h3. Manuals
126 90 johu
127 75 johu
* Rules (TODO)
128 87 johu
* [[development_getting_started|Getting started]]
129 87 johu
* [[development_git_patches|Git Patches]]
130 89 johu
* [[development_translations|Translations]]
131 72 johu
132 72 johu
h3. Feature Drafts
133 71 johu
134 1 seezer
* [[Blowfish Encryption]]
135 98 MoleMan
* [[Possible_Scripting_Object]]
136 94 Sputnick
137 94 Sputnick
h3. Technical Documentation
138 94 Sputnick
139 94 Sputnick
* [[doc_quassel_protocols|The Quassel Protocol]]