Project

General

Profile

QuasselWiki » History » Version 126

gildarts, 08/08/2020 10:06 PM
Rollback vandalism

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