network/ruqola/README.md

0001
0002 # ruqola
0003
0004 Ruqola is a Rocket.Chat client for the KDE desktop.
0005
0006 ## Features
0007
0008 It supports RC feature:
0009 - Direct Message
0010 - group channel
0011 - channel
0012 - Support autotranslate (when RC has it)
0013 - Configuring room notification
0014 - Configuring room
0015 - Thread message support
0016 - Discussion room
0017 - Teams room support
0018 - Configuring own account
0019 - Registering new account
0020 - Support multi account
0021 - Search message in room.
0022 - Show mention/attachment/Pinned message/start message
0023 - Support emoji
0024 - Video support
0025 - Configure administrator support (add/remove roles, add/remove users, add/remove permissions, configure rooms etc.)
0026 - Support OTR (in progress)
0027 - support gif image
0028 - Add support for uploading attachment files.
0029 - Show unread message information
0030 - Allow to block/unblock users
0031 - Auto-away
0032 - Two-factor authentication via TOTP
0033 - Two-factor authentication via email
0034 - Administrator support (Server Info, Rooms, Custom User Status, Custom Sounds, Custom Emoji, Users, Invites, View Log, Permissions, Roles, Oauth), Administrator settings (Message, Account, Retention Policy, File Upload, Encryption)
0035 - Export Messages
0036
0037 Extra features:
0038 - Allow to reply directly to message from notification (kde features)
0039 - Dnd image from ruqola to website or local folder
0040 - Store message in local database so we can search in offline
0041 - Mark All Channels are read
0042 - Add notification history.
0043
0044
0045
0046 ## Source Code
0047
0048 You can get ruqola from:
0049
0050 - <https://github.com/KDE/ruqola>
0051 - git@invent.kde.org:network/ruqola.git
0052 - https://invent.kde.org/network/ruqola.git
0053
0054 ## Requirements
0055
0056 `cmake`, `cmake-extra-tools`, `qt5-websockets`, `qt5-networkauth`, `qt5-multimedia`, `kwidgetaddons`, `ki18n`, `kcrash`, `kcoreaddons`, `syntaxhighlighting`, `sonnet`, `textwidgets`, `notifyconfig`, `kio`, `iconthemes`, `xmlgui`
0057
0058 ## How to build ruqola
0059
0060 ````bash
0061 mkdir build
0062 cd build
0063 cmake ..
0064 make
0065 make install
0066 ````
0067 or using CMakePresets support (need cmake > 3.20)
0068 ````
0069 cmake --preset dev && cmake --build --preset dev
0070 ````
0071
0072
0073 Build against qt6
0074 ````
0075 cmake --preset dev && cmake --build --preset dev-qt6
0076 ````
0077
0078
0079 ## ASAN
0080
0081 We can use sanitizers.supp file
0082 example: LSAN_OPTIONS=suppressions=../sanitizers.supp ./bin/ruqolaserverconfigtest
0083
0084
0085 ## UNITY
0086
0087 We can build with cmake unity support
0088 ````
0089 cmake --preset unity && cmake --build --preset unity
0090 ````
0091
0092 ## Maintainer
0093
0094 - Laurent Montel <montel@kde.org>
0095