/cpaneltop

CpanelTop is a python script for monitor cpanel host resource usage

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

cpaneltop logo

made-with-python Codacy Badge Tested on cpanel version GPLv3 license GitHub repo size GitHub stars

CpanelTop

cpaneltop is a Python command line script to monitor the usage of cpanel resources. cpaneltop can login to your host panel and fetch the statistics table and display resource usage in your terminal

screenshot



Installation

for using this program ,you can run cpaneltop.py that provided in cpaneltop/appdirectory manually
or install it using installer in linux machins

first of all you need to clone the directory :

git clone "https://github.com/Gictorbit/cpaneltop.git" && cd cpaneltop

and then should install python package reqirements

pip install -r requirements.txt

install with installer script

chmod +x install.sh
./install.sh

run manually

cd app/
python3 cpaneltop.py



Usage

You can also customize your requests with the parameters defined in the program .
in this section , cpaneltop parameters explained:

username@host

for connect to your cpanel host you should enter your username and domain or ip address as parameter
with following format:

username@domain

    cpaneltop username@host
port (-p , --time)

By default the script uses the specified cpanel port 2082
you can change it with -p or --port arguments

cpaneltop username@host -p 1234

or

cpaneltop username@host --port 2082
time (-t , --time)

the another parameter you can use is -t or --time
By default, this program refresh your cpanel host information every 10 seconds.
If you do'nt want to do this, you can set the time argument to 1 with Doing this , will no longer update the information and only display detail for one request .

cpaneltop username@host --time 1

or you can customize update time with numeric values between 5 untill 60 second.

cpaneltop username@host -t 25
ssl (-s , --ssl)

most users have http connection on cpanel login page ,so cpaneltop uses to http by default.
if you have https connection you should use -s or --ssl parameter and pass yes or no arguments to that.

cpaneltop username@host --ssl yes
PassWord after using above parameters you can hit enter key and enter your password in secure mode

Note

for exit from program you shoud press q button



Example

cpaneltop admin@example.com 
cpaneltop admin@example.com -t 5
cpaneltop admin@example.com -p 12345 --time 12
cpaneltop admin@example.com -p 12345 -t 7 -s yes



License

GitHub

cpaneltop is licensed under the GNU General Public License v3.0