Nemcio/SysTray-X
1
0
Fork 0
mirror of https://github.com/Ximi1970/systray-x.git synced 2025-10-26 07:46:09 +01:00
Code Issues Packages Projects Releases Activity
Files
04f3f35ead6b2e93c9c0191a905560ea145c3814
SysTray-X/README.md
Maxime Rijnders 04f3f35ead Update README.md
2023-10-14 21:06:42 +02:00

18 KiB
Raw Blame History

SysTray-X

SysTray-X is a system tray extension for Thunderbird. The addon uses the WebExtension API's to control an external system dependent system tray application.

The addon and system tray application can do:

  • custom new mail icon
  • display number of unread / new mails
  • optional new mail indicator (icon or shading)
  • run app on start or close
  • show / hide Thunderbird (minimize)
  • minimizing hides to tray (remove Thunderbird from taskbar, pager and switcher when minimized)
  • minimize on startup
  • minimize on close

Warning:

This add-on and companion app will NOT work with FULL Wayland desktops. No interaction between window clients is possible in Wayland.
Nor will it currently work with flatpaks or snaps of Thunderbird. They do not allow native messaging hosts outside the packages.

Donations

To support this project, you can make a donation to its current maintainer:

paypal bitcoin-qrcode-black

Contributers

Luigi Baldoni <aloisio@gmx.com> : Initial setup of the OpenSuSE Build Service rpm package.

Known issues

  • Upgrading a Windows version (pre 0.9.4):

    • Quit Thunderbird
    • Install the new version of Systray-X (SysTray-X-setupxx-0.x.0.exe from the release assets)
    • Start Thunderbird again
    • Goto Tools -> Add-ons and Themes
    • Click on the "gear" button / menu
    • Click the "Install Add-on From File" menu item
    • Browse to "C:\Program Files\Systray-X
    • Select "systray-x@Ximi1970.xpi"

  • SysTray-X preferences will be lost when moving from an old Thunderbird version to Thunderbird version 91 or higher due to the storage type change. As of SysTray-X version 0.8.0 the add-on will use the local storage type instead of the sync type.
    Please press the reset button in the TB SysTray-X add-on preferences page to clear the old storage before setting your preferences again.

  • Preferences menu not working in TB 86.x throught TB 87.0b1 (beta releases)

Limitations

This add-on / companion app will not work with FULL Wayland desktops due to the design choices made in Wayland.
Nor will it currently work with flatpaks or snaps of Thunderbird. They do not allow native messaging hosts outside the packages.

Binaries (System)

These packages will install the Thunderbird addon and companion app system wide.
Root credentials are required.

Make shure you removed / uninstalled any SysTray-X package installed with a script installer.
You can verify this by checking the ~/.mozilla/native-messaging-hosts directory. There should be NO SysTray-X packages or links in there. Remove them and remove the add-on from the Thunderbird add-ons page.

Linux distributions

openSuSE

Repository

Installing the repository:

Tumbleweed
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Tumbleweed/ SysTray-X
15.5
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/15.5/ SysTray-X
15.4
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/15.4/ SysTray-X
Leap 15.4
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Leap_15.4/ SysTray-X

Package

Installing the SysTray-X addon and companion app package:

KDE
sudo zypper in systray-x
GNOME
sudo zypper in systray-x-gnome
XFCE / Others (non-KDE, non-GNOME)
sudo zypper in systray-x-minimal

xUbuntu

Repository

Installing the repository:

23.10
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_23.10/Release.key
sudo mv -f  Release.key  /etc/apt/trusted.gpg.d/Systray-x.Ximi1970.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_23.10 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
23.04
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_23.04/Release.key
sudo mv -f  Release.key  /etc/apt/trusted.gpg.d/Systray-x.Ximi1970.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_23.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
22.04 LTS
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_22.04/Release.key
sudo mv -f  Release.key  /etc/apt/trusted.gpg.d/Systray-x.Ximi1970.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_22.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
20.04 LTS
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_20.04/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_20.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
18.04 LTS
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_18.04/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_18.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
16.04 LTS
wget -q http://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_16.04/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb http://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/xUbuntu_16.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update

Package

Installing the SysTray-X addon and companion app package:

KDE

Please select the Plasma (X11) session when loging in on 21.04. The Plasma (Wayland) session will not work.

sudo apt install systray-x
GNOME

Please select the Ubuntu on Xorg session when loging in on 21.04 and up. The Ubuntu (Wayland) session will not work.

sudo apt install systray-x-gnome

Disabling wayland:

sudo nano /etc/gdm3/custom.conf

and change (and remove the leading '#' when needed)

WaylandEnable=true

into

WaylandEnable=false
Unity / XFCE / Others (non-KDE, non-GNOME)
sudo apt install systray-x-minimal

Debian

Repository

Installing the repository:

Testing (not tested)
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Testing/Release.key
sudo cp -f Release.key /etc/apt/trusted.gpg.d/SysTray-X.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Testing ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
Unstable (not tested)
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Unstable/Release.key
sudo cp -f Release.key /etc/apt/trusted.gpg.d/SysTray-X.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Unstable ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
12
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_12/Release.key
sudo cp -f Release.key /etc/apt/trusted.gpg.d/SysTray-X.asc
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_12 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
11
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_11/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_11 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
10
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_10/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_10 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update

Package

Installing the SysTray-X addon and companion app package:

KDE
sudo apt install systray-x
GNOME
sudo apt install systray-x-gnome

Disabling wayland:

sudo nano /etc/gdm3/daemon.conf

and change (and remove the leading '#' when needed)

WaylandEnable=true

into

WaylandEnable=false
XFCE / Others (non-KDE, non-GNOME)
sudo apt install systray-x-minimal

Fedora

Repository

Installing the repository:

Rawhide (not tested)
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_Rawhide/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
39
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_39/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
38
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_38/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
37
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_37/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
36
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_36/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh

Package

Installing the SysTray-X addon and companion app package:

KDE
sudo dnf install systray-x
GNOME
sudo dnf install systray-x-gnome
XFCE / Others (non-KDE, non-GNOME)
sudo dnf install systray-x-minimal

Manjaro, Arch

AUR

Repository

Installing the repository:

wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons:/Arch/Arch/x86_64/home_Ximi1970_Mozilla_Add-ons_Arch_Arch.key
sudo pacman-key --add home_Ximi1970_Mozilla_Add-ons_Arch_Arch.key
sudo pacman-key --lsign-key BEEF5C3607D86FE9
sudo echo -e "\n[home_Ximi1970_Mozilla_Add-ons_Arch_Arch]\nSigLevel = PackageOptional\nServer = https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons:/Arch/Arch/x86_64" | sudo tee -a /etc/pacman.conf 
sudo pacman -Syyu

Package

Installing the SysTray-X addon and companion app package:

KDE
sudo pacman -S systray-x
GNOME
sudo pacman -S systray-x-gnome

Please use gnome-extensions to enable the gnome shell extension appindicatorsupport@rgcjonas.gmail.com. Reboot or relogin is probably also needed.

XFCE / Others (non-KDE, non-GNOME)
sudo pacman -S systray-x-minimal

AUR alternative install (by Antiz96)

Install the systray-x package from the Arch repo. This is a split package that will offer you to either install the systray-x-common package which is suitable for any DE/WM except KDE (Gnome users need to install and enable the gnome-shell-extension-appindicator for a proper integration with Gnome) or the systray-x-kde package which includes specific options and dependencies for a proper integration with KDE.

sudo pacman -S systray-x

You can directly install the systray-x-common or the systray-x-kde package instead, if you already know the one you want to install. Alternatively, there's a systray-x-git package available in the AUR.

CentOS

Repository

Installing the repository:

8 Stream (not tested)
sudo yum-config-manager --add-repo=https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/CentOS_8_Stream/home:Ximi1970:Mozilla:Add-ons.repo
sudo yum update
8
sudo yum-config-manager --add-repo=https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/CentOS_8/home:Ximi1970:Mozilla:Add-ons.repo
sudo yum update
7
sudo yum-config-manager --add-repo=https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/CentOS_7/home:Ximi1970:Mozilla:Add-ons.repo
sudo yum update

Package

Installing the SysTray-X addon and companion app package:

KDE
sudo yum install systray-x-minimal

or

sudo yum install epel-release
sudo yum install systray-x
GNOME
sudo yum install systray-x-gnome

Please use gnome-extensions to enable the gnome shell extension appindicatorsupport@rgcjonas.gmail.com. Reboot or relogin is probably also needed.

MX (not tested)

First install the Debian latest Thunderbird version. Replace the xx.x.x with the correct version.

sudo apt install thunderbird=1:xx.x.x-1~deb10u1

Then add the SysTray-X Debian repository and install the SysTray-X package.

sudo apt install thunderbird=1:78.x.x-1~deb10u1
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_10/Release.key
sudo apt-key add Release.key
sudo bash -c 'echo "deb https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_10 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
sudo apt install systray-x-minimal

Binaries (User)

User installable package.
No root credentials required.

Download the installer here (click on the assets dropdown list):

Addon and companion app installer

Please keep in mind that using the script will override the SysTray-X packages installed with a repository. Use the -u option with the script installer to uninstall.

Windows

Get the SysTray-X-setup32-x.x.x.exe or SysTray-X-setup64-x.x.x.exe depending on the Thunderbird version (32bit or 64bit) you are using.
Run the installer.
If you want to change the install directory, please make sure to select an empty / unused directory.
ALL files in the selected install directory will be removed when uninstalling !! Please remove the Systray-X add-on from Thunderbird before uninstalling.

When reinstalling you need to add the add-on manually to Thunderbird again by using the Installl Add-On From File option in the Add-ons manager. You can find add-on file in the install directory called systray-x@Ximi1970.xpi

Building

Linux

Clone the repository:

git clone https://github.com/Ximi1970/systray-x.git

Requirements:

  • OpenSuSE:

    sudo zypper install zip git gcc-c++ make qt5-qtbase-devel knotifications-devel

  • Fedora/RHEL:

    sudo dnf install qt5-qtbase-devel gnome-shell-extension-appindicator kf5-knotifications-devel
gnome-extensions enable appindicatorsupport@rgcjonas.gmail.com

  • CentOS:

    sudo yum install epel-release
sudo yum install kf5-knotifications-devel
sudo yum install qt5-qtbase-devel

    If you want to use systray-x under Gnome you also need to add the SysTray-X repository for your CentOS version (replace the XX with your version):

    sudo yum-config-manager --add-repo=https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/CentOS_XX/home:Ximi1970:Mozilla:Add-ons.repo
sudo yum update
sudo yum install gnome-shell-extension-appindicator
gnome-extensions enable appindicatorsupport@rgcjonas.gmail.com

  • Ubuntu:

    20.04 LTS

    sudo apt install zip git g++ make qt5-default
gnome-extensions enable ubuntu-appindicator@ubuntu.com

    16.04 LTS / 18.04 LTS

    sudo apt install zip git g++ make qt5-default gnome-shell-extension-appindicator
gnome-shell-extension-tool -e ubuntu-appindicator@ubuntu.com

  • Debian:

    sudo apt install zip git g++ make qt5-default gnome-shell-extension-appindicator
gnome-shell-extension-tool -e ubuntu-appindicator@ubuntu.com

Build (KDE):

cd systray-x
make

or if knotifications is not available:

cd systray-x
make OPTIONS="DEFINES+=NO_KDE_INTEGRATION"

Build (GNOME,XFCE,others):

cd systray-x
make OPTIONS="DEFINES+=NO_KDE_INTEGRATION"

Install and run SysTray-X from the build directory in the repository:

mkdir -p ~/.mozilla/native-messaging-hosts
cp -f app/config/linux/SysTray_X.json ~/.mozilla/native-messaging-hosts/
cp -f systray-x@Ximi1970.xpi ~/.thunderbird/*.default-release/extensions/

User install:

...

System install:

...

Windows

Install:

Clone the repository using TortoiseGit:

...

Translations

de :
el : askembris
en_US :
it : lgbaldoni
nl :
pt_BR : fabianski7
ru_RU : agvantibo

Remarks

Branches:

master : Should be stable and working for all supported systems
develop : Working but maybe not for all systems
feature-xxx : Experimental