* PingPanel INSTALL.txt (C) 2024 by Siegrist(SystemLösungen) <pingpanel@zweiernet.ch>

INSTALL
========

On Debian/Ubuntu related systems install with:
----------------------------------------------
- #dpkg -i  pingpanel_<version>_all.deb

You may encounter problems like:
	dpkg: dependency problems prevent configuration of pingpanel:
	 pingpanel depends on python3-tornado (>= 6.0); however:
	  Package python3-tornado is not installed.
	 pingpanel depends on fping (>= 5.0); however:
	  Package fping is not installed.
	  
Then, check the dependencies with:
- #apt-get check
and install the dependencies with:
- #apt --fix-broken install
Afterwards the pingpanel package ist fully instsalled under /opt/PingPanel/.

The daemon start file pingpanel in the init.d/ directory is in the standard LSB format for SysV systems.
So, on systemd related systems at least use:
- #systemctl daemon-reload

After all, start the PingPanel Daemon:
- #service pingpanel start



On other systems using the tar-archive:
---------------------------------------
- #cd /opt
- #tar xvfz pingpanel_<version>.tar.gz

Requirements:
- python3-tornado >= 6.0 (https://www.tornadoweb.org/en/stable/)
- fping >= 5.0 (https://fping.org/)

The directory ./etc.example contains startup file in ./init.d and a default pingpanel file under ./default.
If you want to use a different installation directory, you must adjust the default file 
and/or the init.d startup script to the appropriate pathes and names.

After all, start the PingPanel Daemon:
- #/etc/init.d/pingpanel start


Configuration
-------------
The configuration is made in the config.cfg file located in the installation directory.
All parameters are documented in this file.
If you want to use a name other than config.cfg, you can specify this in the /etc/default/pingpanel file
or with the -c <filename> param to the PingPanel.py script.

All Messages are written to the file /var/log/pingpanel.log, unless 
you define a different name in /etc/default/pingpanel.


Upgrade
========

On Debian/Ubuntu related systems upgrade with:
----------------------------------------------
- #dpkg -i  pingpanel_<version>_all.deb

The configuration files (config.cfg and /etc/default/pingpanel) will be preserved.
New files will be given the prefix .dpkg-NEW.
Adjust your config.cfg file with the new paramameters from .dpkg-NEW.

Restart the PingPanel Daemon.


On other systems using the tar-archive:
---------------------------------------
Install the tar-file in a new empty directory and then copy the relevant files to your active install-dir.



sigi