Files
SysTray-X/README.md
2021-09-05 13:55:39 +02:00

581 lines
15 KiB
Markdown

# SysTray-X
SysTray-X is a system tray extension for Thunderbird 68+. 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 mails
- 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.
## Donations
To support this project, you can make a donation to its current maintainer:
[![paypal](https://github.com/Ximi1970/Donate/blob/master/paypal_btn_donateCC_LG_2.gif)](https://paypal.me/Ximi1970)
[![bitcoin-qrcode-black](https://github.com/Ximi1970/Donate/blob/master/bitcoin-donate-qrcode-black.png)](https://raw.githubusercontent.com/Ximi1970/Donate/master/bitcoin-address.txt)
## Contributers
Luigi Baldoni \<aloisio@gmx.com\> : Initial setup of the OpenSuSE Build Service rpm package.
## Known issues
- 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.
## 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.
### openSuSE
#### Repository
Installing the repository:
###### Tumbleweed
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Tumbleweed/ SysTray-X
```
###### Leap 15.3 (not tested)
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Leap_15.3/ SysTray-X
```
###### Leap 15.2
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Leap_15.2/ SysTray-X
```
###### Leap 15.1
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_Leap_15.1/ SysTray-X
```
###### SLE 15 SP3 (not tested)
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_SLE_15_SP3/ SysTray-X
```
###### SLE 15 SP2 (not tested)
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_SLE_15_SP2/ SysTray-X
```
###### SLE 15 SP1 (not tested)
```bash
sudo zypper ar -f https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/openSUSE_SLE_15_SP1/ SysTray-X
```
#### Package
Installing the SysTray-X addon and companion app package:
###### KDE
```bash
sudo zypper in systray-x
```
###### GNOME
```bash
sudo zypper in systray-x-gnome
```
###### XFCE / Others (non-KDE, non-GNOME)
```bash
sudo zypper in systray-x-minimal
```
### xUbuntu
#### Repository
Installing the repository:
###### 21.04
```bash
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_21.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_21.04 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
```
###### 20.10
```bash
wget -q https://download.opensuse.org/repositories/home:/Ximi1970/xUbuntu_20.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_20.10 ./" > /etc/apt/sources.list.d/systray-x.list'
sudo apt update
```
###### 20.04 LTS
```bash
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
```bash
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
```bash
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.
```bash
sudo apt install systray-x
```
###### GNOME
Please select the `Ubuntu on Xorg` session when loging in on 21.04. The `Ubuntu` (Wayland) session will not work.
```bash
sudo apt install systray-x-gnome
```
###### Unity / XFCE / Others (non-KDE, non-GNOME)
```bash
sudo apt install systray-x-minimal
```
### Debian
#### Repository
Installing the repository:
###### Testing (not tested)
```bash
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Testing/Release.key
sudo apt-key add Release.key
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)
```bash
wget -q https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Debian_Unstable/Release.key
sudo apt-key add Release.key
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
```
###### 10
```bash
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
```bash
sudo apt install systray-x
```
###### GNOME
```bash
sudo apt install systray-x-gnome
```
###### XFCE / Others (non-KDE, non-GNOME)
```bash
sudo apt install systray-x-minimal
```
### Fedora
#### Repository
Installing the repository:
###### Rawhide (not tested)
```bash
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
```
###### 34
```bash
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_34/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
```
###### 33
```bash
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_33/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
```
###### 32
```bash
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:/Ximi1970:/Mozilla:/Add-ons/Fedora_32/home:Ximi1970:Mozilla:Add-ons.repo
sudo dnf update --refresh
```
#### Package
Installing the SysTray-X addon and companion app package:
###### KDE
```bash
sudo dnf install systray-x
```
###### GNOME
```bash
sudo dnf install systray-x-gnome
```
###### XFCE / Others (non-KDE, non-GNOME)
```bash
sudo dnf install systray-x-minimal
```
### Arch
#### AUR
A `git` package is available in the user repository (KDE Plasma version). To install it, just use some AUR helper, like yay:
`yay -S systray-x-git`
#### Repository
Installing the repository:
```bash
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
```bash
sudo pacman -S systray-x
```
###### GNOME
```bash
sudo pacman -S systray-x-gnome
sudo pacman -S gnome-tweaks
```
Please use `Tweaks` to activate the gnome shell extension `Kstatusnotifieritem/appindicator support` or reboot the system.
###### XFCE / Others (non-KDE, non-GNOME)
```bash
sudo pacman -S systray-x-minimal
```
### CentOS
#### Repository
Installing the repository:
###### 8 Stream (not tested)
```bash
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
```bash
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
```bash
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
```bash
sudo yum install systray-x-minimal
```
or
```bash
sudo yum install epel-release
sudo yum install systray-x
```
###### GNOME
```bash
sudo yum install systray-x-gnome
sudo yum install gnome-tweaks
```
Please use `Tweaks` to activate the gnome shell extension `Kstatusnotifieritem/appindicator support` or reboot the system.
### MX (not tested)
First install the Debian latest Thunderbird version. Replace the xx.x.x with the correct version.
```bash
sudo apt install thunderbird=1:xx.x.x-1~deb10u1
```
Then add the SysTray-X Debian repository and install the SysTray-X package.
```bash
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](https://github.com/Ximi1970/systray-x/releases)
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:
```bash
git clone https://github.com/Ximi1970/systray-x.git
```
Requirements:
- OpenSuSE:
```bash
sudo zypper install zip git gcc-c++ make qt5-qtbase-devel knotifications-devel
```
- Fedora/RHEL:
```bash
sudo dnf install qt5-qtbase-devel gnome-shell-extension-appindicator kf5-knotifications-devel
gnome-extensions enable appindicatorsupport@rgcjonas.gmail.com
```
- CentOS:
```bash
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):
```bash
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
```bash
sudo apt install zip git g++ make qt5-default
gnome-extensions enable ubuntu-appindicator@ubuntu.com
```
16.04 LTS / 18.04 LTS
```bash
sudo apt install zip git g++ make qt5-default gnome-shell-extension-appindicator
gnome-shell-extension-tool -e ubuntu-appindicator@ubuntu.com
```
- Debian:
```bash
sudo apt install zip git g++ make qt5-default gnome-shell-extension-appindicator
gnome-shell-extension-tool -e ubuntu-appindicator@ubuntu.com
```
Build (KDE):
```bash
cd systray-x
make
```
or if `knotifications` is not available:
```bash
cd systray-x
make OPTIONS="DEFINES+=NO_KDE_INTEGRATION"
```
Build (GNOME):
```bash
cd systray-x
make OPTIONS="DEFINES+=NO_KDE_INTEGRATION"
```
Install and run SysTray-X from the build directory in the repository:
```bash
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:
- [Visual Studio Express 2017](https://aka.ms/vs/15/release/vs_WDExpress.exe)
- [Visual Code Studio](https://code.visualstudio.com/)
- [Git for Windows](https://gitforwindows.org/)
- [TortoiseGit](https://tortoisegit.org/)
- [PuTTY](https://www.putty.org/)
- [Qt](https://www.qt.io/download-thank-you?os=windows&hsLang=en)
Clone the repository using TortoiseGit:
...
### Translations
de :
el : askembris
en_US :
it : lgbaldoni
nl :
pt_BR : fabianski7
ru_RU : PutinVladimir
### Remarks
Branches:
master : Should be stable and working for all supported systems
develop : Working but maybe not for all systems
feature-xxx : Experimental