Project

General

Profile

QuasselWiki » History » Version 217

romibi, 12/29/2023 12:51 PM
removed "romibis custom builds" links

1 216 henk
h1. Quassel
2 214 phuzion
3 216 henk
{{toc}}
4 1 seezer
5 216 henk
h2. Introduction
6 216 henk
7 216 henk
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".
8 216 henk
9 216 henk
Quassel's distributed approach:
10 216 henk
11 216 henk
!distributed.png!
12 216 henk
13 216 henk
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).
14 216 henk
15 216 henk
h2. Getting started
16 216 henk
17 216 henk
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.
18 216 henk
19 216 henk
h3. Installation
20 216 henk
21 216 henk
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.
22 216 henk
23 216 henk
h3. Connecting to the core
24 216 henk
25 216 henk
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.
26 216 henk
All that is completely optional.
27 216 henk
28 216 henk
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.
29 216 henk
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.
30 216 henk
31 216 henk
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).
32 216 henk
33 216 henk
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!
34 216 henk
35 216 henk
More users can be added by passing command line arguments to the core (see [[Manage core users|Managing core users]]).
36 216 henk
37 216 henk
h3. IRC Configuration
38 216 henk
39 216 henk
Now you have to specify which network(s) Quassel should connect to. First you will have to create an identity.
40 216 henk
41 216 henk
!identity.png!
42 216 henk
43 216 henk
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.
44 216 henk
45 216 henk
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.
46 216 henk
47 216 henk
!network.png!
48 216 henk
49 216 henk
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 Libera Chat!
50 216 henk
51 216 henk
h2. Manuals
52 216 henk
53 216 henk
h3. Core
54 216 henk
* Autostart QuasselCore on:
55 216 henk
** [[Autostart Core on Mac|Mac]]
56 216 henk
** [[QuasselCore As A Service (Windows)|Windows]]
57 216 henk
* Backends
58 216 henk
** [[PostgreSQL]]: Setting up PostgreSQL database back-end
59 216 henk
** [[SQLite]]: Some information about the SQLite back-end
60 216 henk
61 216 henk
h3. Shared
62 216 henk
* [[Blowfish Encryption Manual|Blowfish Encryption]]: Encrypt IRC messages in a channel or in a query
63 216 henk
* [[Quassel Logging|Logging in Quassel]]: Fetching and searching the Quassel logs
64 216 henk
* [[SSH Tunneling]]: How to tunnel the client-core connection over SSH
65 216 henk
* [[Client-Core SSL support|SSL support]]: How to encrypt the connection between clients and core
66 216 henk
* [[Manage core users|User management]]: How to add users to the core
67 216 henk
* [[Migrating from Monolithic to Client+Core]]: How to migrate from the monolithic client to client + core.
68 216 henk
* [[Quassel Config File Format|Reading Quassel Config Files]]: How to read and understand a quassel configuration file.
69 216 henk
70 216 henk
h3. Client
71 216 henk
* GUI Customization
72 216 henk
** [[Buffer Views|Chat Lists]]: Filter your channels to the ones you really need, or split channels & queries into separate widgets.
73 216 henk
*** [[Customize chats order]]
74 216 henk
** [[Chat View]]
75 216 henk
*** [[Chat View#hide-events|Hide Events]]: Hide Join, Parts and Quits.
76 216 henk
** [[Stylesheets]]: Advanced theming of the entire client.
77 216 henk
*** [[Stylesheet Gallery]]: List of stylesheets made by users.
78 216 henk
** [[Customize Icons]]
79 216 henk
80 216 henk
* [[Shortcuts]]
81 216 henk
82 216 henk
h2. Frequently asked questions
83 216 henk
84 216 henk
Check the [[FAQ]]
85 216 henk
86 216 henk
h2. Known issues
87 216 henk
88 216 henk
[[GSoC 2016]]
89 216 henk
90 216 henk
* DCC chat and file transfers are not yet supported.
91 216 henk
* See "Issues":http://bugs.quassel-irc.org/projects/quassel-irc/issues for specific bugs and feature requests.
92 216 henk
93 216 henk
h2. Unofficial builds
94 216 henk
95 216 henk
See also the [[Mobile]] page.
96 216 henk
97 216 henk
h3. Linux
98 216 henk
99 216 henk
* "Backported packages for Debian Jessie, amd64 only":https://iskrembilen.com/quassel-packages-debian/
100 216 henk
* "PPA for Ubuntu with latest versions of Quassel":https://launchpad.net/~mamarley/+archive/ubuntu/quassel
101 216 henk
102 216 henk
h3. Windows
103 216 henk
104 216 henk
* "x64 only, requires VS2013 runtime":http://files.1f0.de/quassel-x64-0.12.2-qt5.4.1.zip
105 216 henk
* "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.
106 216 henk
107 216 henk
h3. Android
108 216 henk
109 216 henk
* "Quasseldroid": https://quasseldroid.info/
110 216 henk
111 216 henk
h2. Development
112 216 henk
113 216 henk
[[Roadmap]]
114 216 henk
115 216 henk
h3. Build guides
116 216 henk
117 216 henk
* [[Build Quassel on Windows]] (with Visual Studio)
118 216 henk
* [[Build Quassel on Windows Mingw|Build Quassel on Windows]] (with MinGW)
119 216 henk
* [[Build Quassel on Linux (english)]]
120 216 henk
* [[Build Quassel on Linux (deutsch)]]
121 216 henk
* [[Build Core On Ubuntu]]: Setting up Quassel core from the source code on Ubuntu server (mostly applies to Debian too)
122 216 henk
* [[Building quasselcore on Ubuntu 8.04 Hardy Heron/x64 (old Qt4 libs)]]
123 216 henk
124 216 henk
h3. Manuals
125 216 henk
126 216 henk
* Rules (TODO)
127 216 henk
* [[development_getting_started|Getting started]]
128 216 henk
* [[development_git_patches|Git Patches]]
129 216 henk
* [[development_translations|Translations]]
130 216 henk
131 216 henk
h3. Feature Drafts
132 216 henk
133 216 henk
* [[Blowfish Encryption]]
134 216 henk
* [[Possible_Scripting_Object]]
135 216 henk
* "Highlights, notifications, and push notifications":http://piratepad.net/vdo3UDwdRR
136 216 henk
* "General next-generation ideas":https://lite6.framapad.org/p/quassel-ng
137 216 henk
138 216 henk
h3. Technical Documentation
139 216 henk
140 216 henk
* [[doc_quassel_protocols|The Quassel Protocol]]