Project

General

Profile

QuasselWiki » History » Version 122

romibi, 10/07/2017 05:03 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 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 115 sandsmark
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. Some community members also provide [[QuasselWiki#Unofficial-builds|unofficial builds]] for various platforms.
26 10 sph
27 10 sph
h3. Connecting to the core
28 40 sph
29 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.
30 54 seezer
All that is completely optional.
31 45 sph
32 92 javier
33 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.
34 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.
35 92 javier
36 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).
37 1 seezer
38 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!
39 1 seezer
40 85 sph
More users can be added by passing command line arguments to the core (see [[Manage core users|Managing core users]]).
41 1 seezer
42 1 seezer
43 15 sph
h3. IRC Configuration
44 15 sph
45 15 sph
Now you have to specify which network(s) Quassel should connect to. First you will have to create an identity.
46 15 sph
47 20 sph
!identity.png!
48 15 sph
49 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.
50 15 sph
51 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.
52 15 sph
53 20 sph
!network.png!
54 15 sph
55 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!
56 5 sph
57 4 pennywise
h2. Manuals
58 39 pennywise
59 103 ChrisH
h3. Core
60 103 ChrisH
* Autostart QuasselCore on:  
61 1 seezer
** [[Autostart Core on Mac|Mac]]
62 1 seezer
** [[QuasselCore As A Service (Windows)|Windows]]
63 103 ChrisH
* Backends
64 103 ChrisH
** [[PostgreSQL]]: Setting up PostgreSQL database back-end
65 103 ChrisH
** [[SQLite]]: Some information about the SQLite back-end
66 103 ChrisH
67 103 ChrisH
h3. Shared
68 1 seezer
* [[Blowfish Encryption Manual|Blowfish Encryption]]: Encrypt IRC messages in a channel or in a query
69 1 seezer
* [[Quassel Logging|Logging in Quassel]]: Fetching and searching the Quassel logs
70 1 seezer
* [[SSH Tunneling]]: How to tunnel the client-core connection over SSH
71 1 seezer
* [[Client-Core SSL support|SSL support]]: How to encrypt the connection between clients and core
72 104 ChrisH
* [[Manage core users|User management]]: How to add users to the core
73 106 ChrisH
* [[Migrating from Monolithic to Client+Core]]: How to migrate from the monolithic client to client + core.
74 120 TC01
* [[Quassel Config File Format|Reading Quassel Config Files]]: How to read and understand a quassel configuration file.
75 1 seezer
76 103 ChrisH
h3. Client  
77 103 ChrisH
* GUI Customization
78 103 ChrisH
** [[Buffer Views|Chat Lists]]: Filter your channels to the ones you really need, or split channels & queries into separate widgets.
79 103 ChrisH
** [[Chat View]]
80 103 ChrisH
*** [[Chat View#hide-events|Hide Events]]: Hide Join, Parts and Quits.
81 105 ChrisH
** [[Stylesheets]]: Advanced theming of the entire client.
82 111 ChrisH
*** [[Stylesheet Gallery]]: List of stylesheets made by users.
83 1 seezer
** [[Customize Icons]]
84 82 sph
* [[Shortcuts]]
85 18 sph
86 57 seezer
h2. Frequently asked questions
87 57 seezer
88 57 seezer
Check the [[FAQ]]
89 57 seezer
90 18 sph
h2. Known issues
91 18 sph
92 117 gry
[[GSoC 2016]]
93 117 gry
94 18 sph
* DCC chat and file transfers are not yet supported.
95 30 dalbers
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.
96 1 seezer
97 112 sandsmark
h2. Unofficial builds
98 1 seezer
99 102 gry
See also the [[Mobile]] page.
100 102 gry
101 78 Datafreak
h3. Linux
102 78 Datafreak
103 112 sandsmark
* "Backported packages for Debian Jessie, amd64 only":https://iskrembilen.com/quassel-packages-debian/
104 112 sandsmark
* "PPA for Ubuntu with latest versions of Quassel":https://launchpad.net/~mamarley/+archive/ubuntu/quassel
105 78 Datafreak
106 1 seezer
h3. Mac
107 1 seezer
108 119 romibi
* "romibi's Custom Builds":https://github.com/romibi/quassel/releases (with some merged experimental stuff, use at your own risk!)
109 1 seezer
110 1 seezer
h3. Windows
111 1 seezer
112 1 seezer
* "x64 only, requires VS2013 runtime":http://files.1f0.de/quassel-x64-0.12.2-qt5.4.1.zip
113 122 romibi
* "Appveyor Git master builds.":https://ci.appveyor.com/project/Quassel/quassel/branch/master To download, click on one of the jobs (e. g. "Environment: COMPILER=msvc15_64"), and then on "Artifacts" to find a list of files.
114 118 romibi
* "romibi's Custom Builds":http://quassel.romibi.ch/ (with some merged experimental stuff, use at your own risk!)
115 116 sandsmark
116 116 sandsmark
h3. Android
117 116 sandsmark
118 116 sandsmark
* "Janne Koschinski's Quasseldroid branch":http://dl.kuschku.de/releases/quasseldroid/
119 1 seezer
120 1 seezer
h2. Development
121 1 seezer
122 1 seezer
[[Roadmap]]
123 114 sandsmark
124 114 sandsmark
125 114 sandsmark
h3. Build guides
126 114 sandsmark
127 114 sandsmark
* [[Build Quassel on Windows]] (with Visual Studio)
128 114 sandsmark
* [[Build Quassel on Windows Mingw|Build Quassel on Windows]] (with MinGW)
129 114 sandsmark
* [[Build Quassel on Linux (english)]]
130 114 sandsmark
* [[Build Quassel on Linux (deutsch)]]
131 114 sandsmark
* [[Build Core On Ubuntu]]: Setting up Quassel core from the source code on Ubuntu server (mostly applies to Debian too)
132 114 sandsmark
* [[Building quasselcore on Ubuntu 8.04 Hardy Heron/x64 (old Qt4 libs)]]
133 109 gry
134 90 johu
h3. Manuals
135 90 johu
136 75 johu
* Rules (TODO)
137 87 johu
* [[development_getting_started|Getting started]]
138 87 johu
* [[development_git_patches|Git Patches]]
139 89 johu
* [[development_translations|Translations]]
140 72 johu
141 72 johu
h3. Feature Drafts
142 71 johu
143 1 seezer
* [[Blowfish Encryption]]
144 98 MoleMan
* [[Possible_Scripting_Object]]
145 121 digitalcircuit
* "Highlights, notifications, and push notifications":http://piratepad.net/vdo3UDwdRR
146 121 digitalcircuit
* "General next-generation ideas":https://lite6.framapad.org/p/quassel-ng
147 94 Sputnick
148 94 Sputnick
h3. Technical Documentation
149 94 Sputnick
150 94 Sputnick
* [[doc_quassel_protocols|The Quassel Protocol]]