Scripts

All scripts and software tools are available in the eenos hosting control panel. The eenos control panel is fully developed in Python. You can see the source code and customize or create your own tools for eenos. All eenos command line tools are available in the folder /usr/local/eenos/scripts a.k.a /scripts/

setupquota

Setup Disk Quotas

This tool will help you to automatically set up disk quotas on your eenos server. Eenos supports disk quotas on ext4 and xfs file systems only.

Command:

/usr/local/eenos/scripts/setupquota

Command Options:

# /usr/local/eenos/scripts/setupquota
Copyright(c) 2020-2022, eenos.com
Setup Disk Quotas - Automatic Disk quota configuration 

Usage: /usr/local/eenos/scripts/setupquota <option> [value] 
Options:
        -a, --auto                      -   To setup automatic disk quota
        -m <mount> , --mount <mount>    -   To enable quota on disk mount point        

Automatic Quota Setup

To detect available disk  partitions and  setup disk quota automatically, use the following command,

Command:

/usr/local/eenos/scripts/setupquota --auto

Enable Quota On a Disk Mount

You can enable disk quota on the new disk  partition which is  already mounted using the following command,

Command:

/usr/local/eenos/scripts/setupquota --mount <mount path>

Example:

Enable disk quota on /home2

/usr/local/eenos/scripts/setupquota --mount /home2

Sometimes you may need to reboot the server to enable disk quota on the root partition (/). Some servers need xfs quota enabled on the boot loader prompt.  You can also set up the disk quota in the generic Linux way. 

setupwebserver

Setup Web Server Combination

This tool will help you to set up and prepare the web servers for deploying websites and apps. Eenos is a modern hosting control panel that brings the modern webserver configuration, which will help to deploy any apps on a web hosting server. 

The default eenos installer will configure your server with Nginx and Apache HTTPD server. The nginx works on the server front-end and the HTTPD server on back-end. 

The eenos control panel is for enterprise high-traffic websites and applications.

Command :

/usr/local/eenos/scripts/setupwebserver

Command Options :


Usage: /usr/local/eenos/scripts/setupwebserver <options> <value>

Command Groups:
Options:
    -i <type> , --install <type>  -   Your choice of web server(s)    
    webserver type : ( chose any of the following )  
        nginx             , Install nginx only web server
        httpd             , Install apache httpd web server
        ols               , Install OpenLiteSpeed web server
        olsvarnish        , install OpenliteSpeed and varnish cache
        nginxhttpd        , Install nginx and apache httpd
        nginxvarnish      , Install nginx with varnish cache
        httpdvarnish      , Install httpd with varnish cache
        nginxhttpdvarnish , Install nginx and httpd with varnish cache
        nginxolsvarnish   , Install nginx and OpenLiteSpeed with varnish cache

Supported Web Server Combinations ( Options)

The eenos control panel supports Nginx, Apache HTTPD, OpenLiteSpeed, and Varnish Cache servers.  The following combinations of web servers are also supported.

nginx

It can be used to install in nginx only web server. Websites and apps run nginx standalone web servers. 

Command

/usr/local/eenos/scripts/setupwebserver -i nginx

A stand-alone Nginx web server is suitable for WordPress websites, which is faster than a traditional HTTPD server.

The Nginx web server doesn't support .htaccess rewrite rules. 

httpd

To install in traditional Apache HTTPD web server.

Command:

/usr/local/eenos/scripts/setupwebserver -i httpd

Modern apps and websites don't recommend Apache anymore.

ols

To install in OpenLiteSpeed stand-alone web server, this is another high-performance web server.

Command:

/usr/local/eenos/scripts/setupwebserver -i ols

There is also a commercial version of OpenLiteSpeed available, called LiteSpeed Enterprise, which has been a drop-in replacement for OLS. This may also work if you replace it with the commercial binary. But remember, it is untested. 

nginxhttpd

The Nginx + Apache HTTPD web servers. It is the default installation choice. It combines the performance of Nginx and the usability of the Apache web server. You can use Nginx as a proxy, hybrid, or stand-alone with this mode. 

The proxy mode will set up the websites as a proxy server and all requests will be served from Apache. The hybrid mode will serve static files from Nginx and dynamic scripts from HTTPD. Stand-alone mode will serve everything from Apache. 

The mode of the website is called app template or vhost template.  Eenos provides a huge combination of optimized app templates for the web server. You can also build the templates or customize them as you wish.

Command:

/usr/local/eenos/scripts/setupwebserver -i nginxhttpd
nginxvarnish

Use a combination of Varnish cache with the Nginx web server. To set up this type of server, use the following command.

Command:

/usr/local/eenos/scripts/setupwebserver -i nginxvarnish

Eenos is the first control panel to provide in-built  Varnish Cache Support.

httpdvarnish

To use a combination of the Varnish cache server with the Apache HTTPD web server,  you may use the following command to set up the server.

Command:

/usr/local/eenos/scripts/setupwebserver -i httpdvarnish
olsvarnish

To set up the Varnish cache server with the OpenLiteSpeed web server, Eenos is the first control panel that provides this combination.

Command:

/usr/local/eenos/scripts/setupwebserver -i olsvarnish
nginxhttpdvarnish

To run the Varnish Cache server in front of the Nginx  + Apache HTTPD server combination to bring maximum performance for web apps.

Command :

/usr/local/eenos/scripts/setupwebserver -i nginxhttpdvarnish
nginxolsvarnish

If you are crazy enough to run a  combination of Varnish Cache with Nginx and OpenLiteSpeed web servers, it is also possible. No one ever did this and we bring this to you.  To set up this combination use the following command.

/usr/local/eenos/scripts/setupwebserver -i nginxolsvarnish

Eenos is the first control panel to Provide Varnish  With Nginx+OpenLiteSpeeed

setupdns

DNS Server Setup Tool

This tool will install and configure a bind DNS server. It will be installed during the control panel installation time.

Command :

/usr/local/eenos/scripts/setupdns

Command Options:

# /usr/local/eenos/scripts/setupdns
Copyright(c) 2020-2022, eenos.com
Eenos DNS server installation tool
This tool will help you to install BIND dns server 

Usage: /usr/local/eenos/scripts/setupdns  <option>

Command Groups:
Options:    
    install=<dnserver> : To install a dns server, where dnserver is the server name

eg:  /usr/local/eenos/scripts/setupdns install=bind  

Install Bind9 DNS Server

Command:

/usr/local/eenos/scripts/setupdns install=bind

Eenos control panel provides the bind9 DNS server distribution at this time.

We will integrate the PowerDNS server in future eenos versions. It is on our to-do list.

setupftp

FTP Server Installation 

This tool will install and set up a pure-ftpd  FTP server on your eenos control panel.

We build and maintain the latest version of pure-ftpd server specially for the eenos control panel.

Command:

/usr/local/eenos/scripts/setupftp

Command Options:

 /usr/local/eenos/scripts/setupftp
Copyright(c) 2020-2022, eenos.com
Eenos FTP server setup tool
This tool will help you to install pure-ftpd FTP server

Usage: /usr/local/eenos/scripts/setupftp  <options>=[values]

Command Groups:
Options:
    --install       -   Install pure-ftpd server
    --rebuildconf   -   Rebuild ftp configuration
    --addaccount    -   Create FTP virtual account

Example  : /usr/local/eenos/scripts/setupftp --install

Install  FTP Server in EEnos

You can use the following command to install ftp server,

Command:

/usr/local/eenos/scripts/setupftp --install

Rebuild  FTP Configuration

To rebuild the ftp server configuration,

Command:

/usr/local/eenos/scripts/setupftp --rebuildconf

Create an FTP Account From the Shell

You can also create an ftp account on a domain using the same tool. The command is as follows,

Command:

/usr/local/eenos/scripts/setupftp --addaccount

setupclamav

Clamav Antivirus Setup Tool

This tool will help you to install ClamAV service and clamd daemon on your server.  We use a custom-built ClamAV distribution which will provide live virus protection using the ClamAV On-Access Scanner service. 

Clamd is a CPU-intensive application. It uses a lot of CPU resources. 

Command :

/usr/local/eenos/scripts/setupclamav

Command Options :

/usr/local/eenos/scripts/setupclamav
Copyright(c) 2020-2022, eenos.com
Eenos Clamav  setup tool
This tool will help you to install Clamav Antivirus

Usage: /usr/local/eenos/scripts/setupclamav  <options>=[values]

Command Groups:
Options:
    --install           -   Install Clamav
    --rebuildconf       -   Rebuild Clamav configuration

Example  : /usr/local/eenos/scripts/setupclamav --install

What is included with the ClamAV package?

The eenos clamav package includes clamav daemon,  clamav On-Access scanner, and Clamav  Database updation.

Clamd 

The Clamav daemon service provides antivirus scanning of emails. It is integrated with the eenos Exim mail server.

On-Access scanner 

This service is a live virus scanner.  Whenever a new  virus file is uploaded to the server, it will be moved to the quarantine folder /var/lib/quarantine  automatically

Some containers like LXC need special privileges to access the fanotify_init  from the kernel.

Freshclam

This is a timer application that will automatically update the Clamav virus database.

Install ClamAV and Related Services

You may use the following command to install ClamAV,  ClamAV On-Access Scanner, and Clamd services.

Command:

 /usr/local/eenos/scripts/setupclamav --install

Rebuild ClamAV Configuration

The following command will rebuild the ClamAV configuration.

Command:

/usr/local/eenos/scripts/setupclamav --rebuildconf
Restart Clamd Service

Command:

systemctl restart clamav-daemon.service
Restart ClamAV  On-Access Scanner

Command:

systemctl restart clamav-clamonacc.service
Restart ClamAV Virus Database Updater

Command :

systemctl restart clamav-freshclam.service

setupeenosd

Eenos Control Panel Web Server Tool

This tool will set up the eenos control panel web server eenosd.  The control panel web services are running on the eenosd daemon. This package is included and compulsory.

Command:

/usr/local/eenos/scripts/setupeenosd

Command Options:

Usage: /usr/local/eenos/scripts/setupeenosd  <options>=[values]

Command Groups:
Options:
    -i, --install           -   Install eenosd web server
    -r, --rebuildconf       -   Rebuild eenosd configuration

Example  : /usr/local/eenos/scripts/setupeenosd --install

Install or Update Eenosd Service

You may use the following command to install or update eenosd.

Command:

/usr/local/eenos/scripts/setupeenosd --install

Rebuild Eenosd Vhosts

To rebuild the eenosd virtual hosts, use the following command,

Command :

/usr/local/eenos/scripts/setupeenosd --rebuildconf

This tool doesn't use always unless you customize the eenosd virtual host template and do a very complicated web server-level customization. We recommend to keep the service as it is provided.  It will be auto-updated as per the need.


setupmailacct

Command Line  Email Account Management Tool

This tool will help you to create, delete, quota settings, and password change of an email account from the server shell. The server administrator can use this friendly tool to manage an email account on any domain on the server.

This is a server admin tool and not an end-user tool.

Command

/usr/local/eenos/scripts/setupmailacct

Command Options:

Usage: /usr/local/eenos/scripts/setupmailacct  <options>=[values]

Command Groups:
Options:
    --add       -   Create a new email account
    --del       -   Delete email account
    --quota     -   Change email quota  
    --chpass    -   Change email password

Example  : /usr/local/eenos/scripts/setupmailacct --add
Create Email Account

Command :

/usr/local/eenos/scripts/setupmailacct --add
Delete Email Account

Command:

/usr/local/eenos/scripts/setupmailacct --del
Change Email Quota

Command:

/usr/local/eenos/scripts/setupmailacct --quota
Change Email Password

Command

/usr/local/eenos/scripts/setupmailacct --chpass

It is always recommended to manage email accounts from the UAPP ( User control panel ), but this tool is handy for some sysadmins.

setupmailman

Mailman3 Mailing List Manager

This tool will set up and install the mailman3 mailing list manager service on your server.  This service doesn't install during the installation time.

Backup, restore and transfer of the Mailman3 mailing list is not possible at this time. The Mailman3 service doesn't have the option to take a backup of a single Mailing List.

Mailman3 service is a CPU-intensive service and it may increase your server load.

Command:

/usr/local/eenos/scripts/setupmailman

Command Options :

Usage: /usr/local/eenos/scripts/setupmailman  <options>=[values]

Command Groups:
Options:
    --install           -   Install Mailman 3    
    --rebuildconf       -   Rebuild Mailman configuration

Example  : /usr/local/eenos/scripts/setupmailman --install

Install Mailman3 

Use the following command to install and setup Mailman3 services,

Command:

/usr/local/eenos/scripts/setupmailman --install

If you are using OpenLiteSpeed  Web  Server, you may need to Edit the file /usr/local/eenos/etc/mailman/mailman.ini  and change the socket to http-socket, and then restart mailmanweb.service. The OLS server doesn't have native uWSGI support yet. 

Rebuild Mailman3 Service Configuration

Command:

/usr/local/eenos/scripts/setupmailman --rebuildconf
Restart   Mailman Service

To restart the mailman service, use the following command.

systemctl restart mailman.service
systemctl status mailman.service
Restart Mailman Web Front end

The mailman3 web front end combines the Hyperkitty and Postorius Python apps. To restart the Mailman web service, use the following command.

systemctl restart mailmanweb.service 
systemctl status mailmanweb.service 
How to create a Mailman3 Mailing list?

Login to the UAPP ( User Control Panel ) to create mailman3 lists.

How to access Mailman 3 web front end?

You may open your browser and  go to https://your-website-name/mailman/

Eenos provides Mailman3 as a feature, but we have only limited technical support for the Mailman 3 service.   Eenos doesn't support the transfer and migration of Mailman3 lists and accounts. 

setupmailserver

Mail Server Setup Tool

This tool can be used to set up Eenos mail server tools like Exim and Dovecot.  You can rebuild the exim configurations and dovecot settings. 

Eenos provides custom-packaged distribution of Exim and Dovecot servers and maintains the package by ourselves. You will always get the updated software with eenos.

Command:

/usr/local/eenos/scripts/setupmailserver

Command Options:

Usage: /usr/local/eenos/scripts/setupmailserver  <options>=[values]

Command Groups:
Options:
    --install           -   Install Exim & Dovecot
    --installexim       -   Install  Exim SMTP server
    --rebuildeximconf   -   Rebuild EXim configuration
    --installdovecot    -   Install Dovecot IMAP/POP3 server
    --rebuilddoveconf   -   Rebuild Dovecot configuration

Install Exim SMTP Server & Dovecot

To install and setup Exim and Dovecot together, use the following command

/usr/local/eenos/scripts/setupmailserver --install

Install Exim Only

To install or update the exim mail server, use the following command,

/usr/local/eenos/scripts/setupmailserver --installexim

Rebuild Exim Configuration

To rebuild the Exim mail server configuration file, use the following command.

/usr/local/eenos/scripts/setupmailserver --rebuildeximconf

Install DoveCot Only

To install Dovecot imap/pop3  service, use the following command,

/usr/local/eenos/scripts/setupmailserver --installdovecot

Rebuild DoveCot Configuration

To rebuild the Dovecot service configuration, use the following command

/usr/local/eenos/scripts/setupmailserver --rebuilddoveconf


setupmodsecurity

ModSecurity 3  Installation

This tool will help you to install and enable modsecurity on your Nginx or HTTPD server.  This tool can also install the CRS  ModSecurity rule set. 

Remember, installing the modsecurity rule may break some websites. You may need to tweak the modsecurity rules, as per your needs. 

Command:

/usr/local/eenos/scripts/setupmodsecurity

Command Options :

Usage: /usr/local/eenos/scripts/setupmodsecurity  <options>=[values]

Command Groups:
Options:    
    -in, --nginx        -   To Enable  Modsecurity3 in Nginx
    -ia, --apache       -   To Enable Modsecurity3 in Apache HTTPD 
    -rn, --removenginx  -   Remove Nginx  ModSecurity
    -ir [vendor], --rule [vendor] :  Install vendor rules, support the following vendors        
        crs -  OWASP® ModSecurity Core Rule Set (CRS)

Enable ModSecurity 3 in HTTPD Server

To enable modsecurity on the Apache httpd server,  use the following command:

/usr/local/eenos/scripts/setupmodsecurity --apache

Enable ModSecurity 3 in Nginx Server

To enable modsecurity on the Nginx web server,  use the following command

/usr/local/eenos/scripts/setupmodsecurity --nginx

Install CRS OWASP rule set

To install OWASP® ModSecurity Core Rule Set (CRS), use  the following command

/usr/local/eenos/scripts/setupmodsecurity -ir crs

setupmongodb

Setup MongoDB Server

This is a MongoDB server installation tool.  Eenos uses the Percona distribution of MongoDB server which provides the features of MongoDB enterprise server.

Eenos is the first hosting control panel that supports MongoDB in shared hosting with full features.

This tool can be used to install and reset the MongoDB root password. 

Command:

/usr/local/eenos/scripts/setupmongodb

Command Options :

Usage: /usr/local/eenos/scripts/setupmongodb  <options>=[values]

Command Groups:
Options:
    --install       -   Install Percona MongoDB Server
    --resetrootpwd  -   Reset MongoDB root password

Install MongoDB Server

To install the MongoDB server, use the following command

/usr/local/eenos/scripts/setupmongodb --install

Reset MongoDB root password

To reset the mongodb server root  password, use the following command,

/usr/local/eenos/scripts/setupmongodb --resetrootpwd

Eenos supports the backup and restoration of MongoDB databases.  Eenos  UAPP provides Mongodb user, role management options with nice features with a rich interface

setupmysql

MySQL Server Setup

This tool will help you to set up a Percona High-Performance MySQL server. The default MySQL server of  Eenos is Percona MySQL server which has better performance than MariaDB and MysQL.

You can add remote MariaDB or MySQL servers from the WAP admin control panel.

Command:

/usr/local/eenos/scripts/setupmysql

Command Options:

Usage: /usr/local/eenos/scripts/setupmysql  <options>=[values]

Command Groups:
Options:
    --install       -   Install Percona MySQL Server
    --resetrootpwd  -   Reset  MySQL root password

Install MySQL Server

To install the MySQL server, use the following command.

/usr/local/eenos/scripts/setupmysql --install

Reset MySQL Root Password

To reset the  MySQL root password, use the following  command

/usr/local/eenos/scripts/setupmysql --resetrootpwd

At this time the default installer will install MySQL version 8.0 

setuppgsql

Setup PostgreSQL Server

This will help you to install the PostgreSQL database server. This tool can be used to reset Postgres password also.

You can add any remote PostgreSQL server from the WAP control panel

Command:

/usr/local/eenos/scripts/setuppgsql

Command Options:

Usage: /usr/local/eenos/scripts/setuppgsql  <options>=[values]

Command Groups:
Options:
    --install       -   Install PostgresSQL Server
    --resetpgpwd  -   Reset postgres password

Install PostgreSQL

To install the Postgresql server, use the following command

/usr/local/eenos/scripts/setuppgsql --install

Reset PostgreSQL Password

To reset the password of the Postgres user, use the following command.

/usr/local/eenos/scripts/setuppgsql --resetpgpwd

At this installation time,  eenos uses PgSQL server version 13  as default.

setuppassenger

Setup App Server

This tool is used to set up the eenos app server which is required to run modern apps using muti Python, Multi NodeJS, and Multi Ruby on Rails Applications. This will install the Passenger server and libraries which will be auto-configured with HTTPD and Nginx servers as modules. OpenLitespeed server doesn't need a Passenger module to run these applications.

Eenos is the first control panel that fully supports sandboxed applications in a hosting environment.

Command:

/usr/local/eenos/scripts/setuppassenger

Command Options:

Usage: /usr/local/eenos/scripts/setuppassenger  <options>=[values]

Command Groups:
Options:    
    -i, --install    -   To install passenger
    -ia, --apache    -   To install mod_passenger in apache httpd
    -in, --nginx     -   To install mod_passenger in Nginx
    -r , --remove    -   Uninstall passenger modules

Install  Passenger on All Web Servers

Use the following command to install the passenger module on all web servers

/usr/local/eenos/scripts/setuppassenger -i

Install Passenger on HTTPD Only

To install Passenger on the Apache httpd server,  use the following command.

/usr/local/eenos/scripts/setuppassenger -ia

Install Passenger on Nginx

To install the passenger module on the Nginx web server, use the following command.

/usr/local/eenos/scripts/setuppassenger -in

Uninstall Passenger

To remove the passenger module,  use the following command

/usr/local/eenos/scripts/setuppassenger -r

Removing passenger may break your websites if it is already hosting Python, nodejs, or Ruby on Rails applications.

setupnodejs

Setup Multiple NodeJS

This tool will help you to set up and manage multiple NodeJS distributions on your server. 

Please set up Passenger before using this tool 

Eenos builds and maintains multiple versions of NodeJS to provide new features to end users.

Command:

/usr/local/eenos/scripts/setupnodejs

Command Options:

Usage: /usr/local/eenos/scripts/setupnodejs <option>  [value]

Command Groups:
Options:   
    -s, --search , search                  : Show available NodeJs versions for installations   
    -l, --list , list                      : Show installed NodeJs versions
    -i <nodejs> , --install <nodejs>       : To install an eenos NodeJs version
    -r <nodejs> , --remove <nodejs>        : To remove NodeJs from server
    -d <nodejs> , --default <nodejs>       : Set the default NodeJs on server    

Search Available NodeJS For installation

To search available node JS for installation, use the following command,

/usr/local/eenos/scripts/setupnodejs -s
eenos-nodejs13 - Node.js is  an asynchronous event-driven JavaScript runtime
eenos-nodejs14 - Node.js is  an asynchronous event-driven JavaScript runtime
eenos-nodejs15 - Node.js is  an asynchronous event-driven JavaScript runtime
eenos-nodejs16 - Node.js is  an asynchronous event-driven JavaScript runtime
eenos-nodejs17 - Node.js is  an asynchronous event-driven JavaScript runtime
eenos-nodejs18 - Node.js is  an asynchronous event-driven JavaScript runtime

Install a NodeJS Version

To install a NodeJS Version use the following command,

/usr/local/eenos/scripts/setupnodejs -i <nodejs>

Example: For installing NodeJS version 18 ( eenos-nodejs18 )

/usr/local/eenos/scripts/setupnodejs -i eenos-nodejs18

Setup Default NodeJS

To setup a default NodeJS version on your eenos control panel, use the following command ( Here version eenos-nodejs18 )

/usr/local/eenos/scripts/setupnodejs -d eenos-nodejs18

List Installed NodeJS 

To show all installed  NodeJs versions in your server, use the following command 

/usr/local/eenos/scripts/setupnodejs -l
Package          Group      NodeJs Version
...........................................
eenos-nodejs16   nodejs16   v16.18.1     
eenos-nodejs17   nodejs17   v17.9.1      
eenos-nodejs18   nodejs18   v18.12.1     
...........................................
Default NodeJs  : eenos-nodejs18

Remove a NodeJS  Version

To remove a NodeJS version from your server, use the following command( here, eenos-nodejs18 )

/usr/local/eenos/scripts/setupnodejs -r eenos-nodejs18

Your hosting clients can manage nodejs apps and npms from the UAPP control panel.

Eenos is the first control panel that provides a full NodeJS app deployment interface in a  hosting server.

setuppython

Setup Multiple Python 

This tool will help you to set up and manage multiple Python distributions on your server. 

Please set up Passenger before using this tool 

Eenos builds and maintains multiple versions of Python to provide new features to end users.

Command:

/usr/local/eenos/scripts/setuppython

Command Options:

Usage: /usr/local/eenos/scripts/setuppython <option>  [value]

Command Groups:
Options:   
    -s, --search , search              : Show available Python versions for installations   
    -l, --list , list                  : Show installed Python versions
    -i <python> , --install <python>       : To install an eenos Python version
    -r <python> , --remove <python>        : To remove Python from server
    -d <python> , --default <python>       : Set the default Python on server 

Search Available Python For Installation

To search available Python  for installation, use the following command,

/usr/local/eenos/scripts/setuppython -s
eenos-python310 - The Python Programming Language
eenos-python311 - The Python Programming Language
eenos-python37 - The Python Programming Language
eenos-python38 - The Python Programming Language
eenos-python39 - The Python Programming Language

Install a Python Version

To install a Python Version, use the following command,

/usr/local/eenos/scripts/setuppython -i <python>

Example:  For installing python 3.9 version ( Here eenos-python39 )

/usr/local/eenos/scripts/setuppython -i eenos-python39

Setup Default  Python

To setup a default Python  version on your eenos control panel, use the following command ( here, version eenos-python39 )

/usr/local/eenos/scripts/setuppython -d eenos-python39

List Installed Python 

To show all installed  Python versions in your server, use the following command 

/usr/local/eenos/scripts/setuppython -l
Package          Group      Python Version   PIP Version   
........................................................
eenos-python310  python310  3.10.8           22.3.1       
eenos-python311  python311  3.11.0           22.3.1       
eenos-python39   python39   3.9.15           22.3.1       
........................................................
Default Python : eenos-python39

Remove a Python Version

 To remove a Python version from your server, use the following command, ( here, eenos-python39 )

/usr/local/eenos/scripts/setuppython -r eenos-python39

Eenos users can manage Python apps (Django, wagtail, uWSGI, etc )  and pip modules from the UAPP control panel.

Eenos is the first hosting control panel to provide a user-friendly Python app hosting in traditional control panels.

setupruby

Setup Multiple Ruby

This tool will help you to set up and manage multiple Ruby distributions on your server. 

Please set up Passenger before using this tool 

Eenos builds and maintains multiple versions of Ruby to provide new features to end users.

Command:

/usr/local/eenos/scripts/setupruby

Command Options:

Usage: /usr/local/eenos/scripts/setupruby <option>  [value]

Command Groups:
Options:   
    -s, --search , search              : Show available Ruby versions for installations   
    -l, --list , list                  : Show installed Ruby versions
    -i <ruby> , --install <ruby>       : To install an eenos Ruby version
    -r <ruby> , --remove <ruby>        : To remove Ruby from server
    -d <ruby> , --default <ruby>       : Set the default Ruby on server  

Search Available Ruby For Installation

To search available Ruby for installation use the following command,

/usr/local/eenos/scripts/setupruby -s
eenos-ruby26 - Ruby programming language
eenos-ruby27 - Ruby programming language
eenos-ruby30 - Ruby programming language
eenos-ruby31 - Ruby programming language

Install a Ruby Version

To install a Ruby Version use the following command,

/usr/local/eenos/scripts/setupruby -i <ruby> 

Example: For installing ruby 3.1 version ( here, eenos-ruby31 )

/usr/local/eenos/scripts/setupruby -i eenos-ruby31

Setup Default  Ruby

To setup a default Ruby  version on your eenos control panel,  use the following command ( here, version eenos-ruby31 )

/usr/local/eenos/scripts/setupruby -d eenos-ruby31

List Installed Ruby

To show all installed  Ruby versions in your server use the following command 

/usr/local/eenos/scripts/setupruby -l
Package          Group      Ruby Version  Gem Version   Rails Version
.....................................................................
eenos-ruby27     ruby27     2.7.7         3.1.6         7.0.4
eenos-ruby30     ruby30     3.0.5         3.2.33        7.0.4
eenos-ruby31     ruby31     3.1.3         3.3.26        7.0.4
.....................................................................
Default Ruby  : eenos-ruby30

Remove a Ruby Version

 To remove a ruby version from your server use the following command, ( here, eenos-ruby31 )

/usr/local/eenos/scripts/setupruby -r eenos-ruby31

Eenos users can manage Ruby on Rails or Ruby apps and gem modules from the UAPP control panel.

Eenos is the first hosting control panel to provide a user friendly Ruby on  Rails app hosting in traditional control panels.

setupphp

Setup Multiple PHP

This document provides the procedure to install and set up multiple php versions on your eenos hosting control panel. Eenos builds and maintains different php versions.

The EOL php versions provided by eenos are packed with security backup ported patch fixes. We will keep those versions as long as the patches are available. 

We recommend using your PHP versions that are actively developed and maintained by the PHP development team.

The installer command and options are below,

Command:

/usr/local/eenos/scripts/setupphp

Command Options:

Usage: /usr/local/eenos/scripts/setupphp  <option>=[value]

Command Groups:
Options:   
    -s, --search , search                       : Show available php versions for installations   
    -l, --list , list                           : Show installed php versions
    -i <php> , --install <php> , install=<php>  : To install an eenos php version
    -r <php> , --remove <php> , remove=<php>    : To remove php from server
    -d <php> , --default <php> , default=<php>  : Set the default php on server
    -b , --buildphpconf                         : To rebuild and update the php.conf in 
    											   apache httpd server  
    -dh <handler> , --defaulthandler <handler>  : To set the default php handler 
    -ph <php> <handler> , --phphandler <php> <handler>  : Change the handler of a php version

Search  PHP Version For Installation

To find all eenos provided php versions, use the following command,

/usr/local/eenos/scripts/setupphp -s
eenos-php56 - Eenos PHP56 complete package
eenos-php70 - Eenos PHP70 complete package
eenos-php71 - Eenos PHP71 complete package
eenos-php72 - Eenos PHP72 complete package
eenos-php73 - Eenos PHP73 complete package
eenos-php74 - Eenos PHP74 complete package
eenos-php80 - Eenos PHP80 complete package
eenos-php81 - Eenos PHP81 complete package

Install PHP Version 

To install a php version, please use the following command.

/usr/local/eenos/scripts/setupphp -i <php>

Example: Install PHP version 8.1 ( here, eenos-php81 )

/usr/local/eenos/scripts/setupphp -i eenos-php81

Remove PHP Version

To remove  a php version from the server use the following command,  ( here, version eenos-php81 )

/usr/local/eenos/scripts/setupphp -r eenos-php81

Default PHP

To set up a default php version for the eenos server, use the following command.

/usr/local/eenos/scripts/setupphp --default <php>

Example: Setup php 8.1 as default php of server

/usr/local/eenos/scripts/setupphp --default eenos-php81

Default PHP Handler

Eenos supports CGI, fcgi, suphp, and fpm php handlers for the Apache httpd server.  The nginx uses fpm and OpenLiteSpeed uses the lsphp handler.

Use the following command to set as default php handler

/usr/local/eenos/scripts/setupphp -dh  <handler>

Example: To set up SuPHP as the default handler

/usr/local/eenos/scripts/setupphp -dh suphp

Setup Handler For a Specific PHP Version

You can set up different handlers for any php version on the eenos server.  Use the following  command to setup a php handler on a specific version,

/usr/local/eenos/scripts/setupphp -ph <php> <handler>

Example: Setup  cgi php handler on php 8.1 version

/usr/local/eenos/scripts/setupphp -ph eenos-php81 cgi

List All Installed PHP Version

To view the installed php version, handlers and default php of the server use the following command

/usr/local/eenos/scripts/setupphp -l
Package          Group      Version    Handler    Available Handlers
.....................................................................
eenos-php71      php71      7.1.33     suphp      cgi,fcgi,suphp,fpm
eenos-php72      php72      7.2.34     suphp      cgi,fcgi,suphp,fpm
eenos-php73      php73      7.3.33     suphp      cgi,fcgi,suphp,fpm
eenos-php74      php74      7.4.33     suphp      cgi,fcgi,suphp,fpm
eenos-php80      php80      8.0.26     suphp      cgi,fcgi,suphp,fpm
eenos-php81      php81      8.1.13     suphp      cgi,fcgi,suphp,fpm
.....................................................................
Default PHP  : eenos-php81
Default php handler : suphp

Rebuild Apache  PHP Configuration

This command will rebuild the Apache php configuration file located on  /etc/httpd/conf.d/php.conf

/usr/local/eenos/scripts/setupphp --buildphpconf

setupspamassassin

Setup Apache SpamAssassin  &  Spamd 

This tool will help you to install the Apache SpamAssassin, the top Open Source anti-spam platform giving system administrators a filter to classify email and block spam (unsolicited bulk email)

This will be automatically integrated with the Exim mail server to detect spam.

Use of Spamd / SpamAssassin may increase the server CPU usage and load.

Command:

/usr/local/eenos/scripts/setupspamassassin

Command Options:

Usage: /usr/local/eenos/scripts/setupspamassassin  <options>=[values]

Command Groups:
Options:
    --install       -   Install Apache SpamAssassin
    --rebuildconf   -   Rebuild SpamAssassin configuration

Install SpamAssassin (Spamd)

To install SpamAssassin use the following command,

The SpamAssassin needs some Perl dependency modules, so it may take some time to finish the installation.

/usr/local/eenos/scripts/setupspamassassin --install

Rebuild SpamAssassin Configuration

To rebuild SpamAssassin configuration use the following command.

/usr/local/eenos/scripts/setupspamassassin --rebuildconf

setupwebmail

Setup Webmail Interface

This tool will install and set up the webmail interface to manage emails from your browser.

Currently, eenos provides Roundcube Webmail as the default webmail service.

Command:

/usr/local/eenos/scripts/setupwebmail

Command Options:

Usage: /usr/local/eenos/scripts/setupwebmail  <options>=[values]

Command Groups:
Options:    
    -ir, --roundcube    -   To install roundcube webmail

Install RoundCube Webmail

This will be automatically installed at the time of installation. You can also use the following command to install or update the roundcube webmail service

/usr/local/eenos/scripts/setupwebmail -ir 

backupacct

Generate Backup Of Hosting Account

This tool will help you to create a complete backup of your Eenos hosting account. This backup can be used to restore on another eenos server.

Command:

/usr/local/eenos/scripts/backupacct

Command Options:

/usr/local/eenos/scripts/backupacct
Copyright(c) 2020-2022, eenos.com
usage: backupacct [options] user 

Create backup of eenos hosting account. By Default create compressed backup

Required:
  user               Eenos user name to backup

Option(s):
  -h, --help         show this help message and exit
  --workdir WORKDIR  The directory to put the package
  --compressed       Compress backup into gzipped tar file (tar.gz)
  --archived         Archive backup into tar file (.tar)
  --nocompress       Neither compressed nor archived backup
  --skiphomedir      Exclude home directory backup
  --skipmysql        Exclude MySQL database backups
  --skippgsql        Exclude PgSQL database backups
  --skipmongodb      Skip Mongodb database backups
  --skipmailman      Exclude Mailman3 mailing list backups
  --skipemail        Exclude email accounts
  --skipbwdata       Exclude bandwidth usage
  --skipdiskusage    Exclude disk usage
  --skippublichtml   Exclude public_html folder
  --log              Enable unique backup log

Create Backup

To create a backup of the eenos hosting account, use the following command

/usr/local/eenos/scripts/backupacct [options] <eenos user>

Example: Create a backup of the eenos hosting account with user name foo

/usr/local/eenos/scripts/backupacct foo

You can generate backup in three different formats.

  1. Compressed Backups
  2. Archived Backup
  3. no compressed Backups

Compressed Backups

This is the default backup option. This will create a compressed gzip tar file as a backup file. The backup file will be ending with .tar.gz format.

Archived Backup

The backups will be created as a tar file without any compression. The backup file end with the extension .tar format.

Non Compressed ( Plain, Incremental, Folder  Based )

This a backup without any type of compression or archiving. The backup name will be a folder name that contains all backup files required to migrate or transfer the account.  

Backup Options

You can include several options with the backup tool for generating the desired type of backup. The default backup option is a compressed backup with full hosting account data. It is suitable for transferring hosting accounts.

The backup options are explained below

--workdir

Use this option to place the generated backup file into a specific folder on your server.

Example:  To backup the eenos user foo

/usr/local/eenos/scripts/backupacct --workdir foo

--compressed

To create a compressed backup you can do as follows.  This is the default backup option.

Example:  To backup the eenos user foo

/usr/local/eenos/scripts/backupacct --compressed foo

--archived

To create an archived backup.

--nocompress

To create a backup without any compressions or archive format.  The backups will be kept inside a folder.

--skiphomedir

Skip copying the home folder of the eenos user account. 

--skipmysql

Exclude MySQL database backups of the given user. 

--skippgsql

Exclude the PostgreSQL database backups of the user.

--skipmongodb

Exclude the MongoDB databases, users, and roles of the user.

--skipmailman

This is a future option for the next version.  Mailman3 backup and restoration are not supported yet.

--skipemail

Skip email account backups.

--skipbwdata

Skip collecting bandwidth usage history of the eenos user.

--skipdiskusage

Skip the backup of the disk usage history of the hosting account.

--skippublichtml

 Exclude the folder public_html, the main document root of the account.

bfdctl

Brute Force  Detection Management (BFD)

This tool will help you to manage the eenos brute force detection service eenosbfd service from the command line. You can view the BFD reports and can manage the blacklisting or whitelisting of the IP addresses.

The Eenos boot force detection service is integrated into the Control panel services( WAP, UAPP, RAPP, etc,.),  FTP login process, Dovecot login process, etc.  This will give ultimate protection from brute force attacks.

The Eenos BFD command is auto-integrated with the server firewalls like CSF,  APF, ufw, and iptables.

Please install one of the firewall services before using the EBFD service.

Command:

/usr/local/eenos/scripts/bfdctl

Command Options:

Usage: /usr/local/eenos/scripts/bfdctl <option> [value]

    -l, --reportshow        - Show last  100 BFD reports
    -la, --reportall        - Show all BFD reports
    -bs, --blacklistshow    - Show Blacklisted IPs
    -ws, --whitelitshow     - Show Whitelisted IPs
    -b <IP>                 - To Blacklist and IP
    -w <IP>                 - To Whitelist an IP
    -r <IP>                 - Remove  an IP from Blacklist
    -rw <IP>                - Remove an IP from Whitelist

View BFD Reports

To view the  BFD reports, use the following command,

/usr/local/eenos/scripts/bfdctl --reportshow

View  Blacklist

To show the blacklisted IPs, use the following  command

/usr/local/eenos/scripts/bfdctl --blacklistshow

View Whitelist 

To show the white-listed IPs, use the following command

/usr/local/eenos/scripts/bfdctl --whitelitshow

Black List an IP

To blacklist an IP, use the following command

/usr/local/eenos/scripts/bfdctl -b <IP>

White List an IP

To Whitelist an IP address, use the following command

/usr/local/eenos/scripts/bfdctl -w <IP>

Remove Black List

To remove an IP from the blacklist, use the following command.

/usr/local/eenos/scripts/bfdctl -r <IP>

Remove from the White List

To remove an IP from the whitelist, please use the following command.

/usr/local/eenos/scripts/bfdctl -rw <IP>

cachepurge

Clear Website Cache

This tool will help you to clear caches from websites and web servers.

Command:

/usr/local/eenos/scripts/cachepurge

Command Options:

Usage: /usr/local/eenos/scripts/cachepurge   <option>

Command Groups:
Options:
    --nginx     -   Clean all Nginx cache
    --ols       -   Clean all OpenLiteSpeed cache
    -d <domain> -   Clean domain cache
    -u <url>    -   Clean url cache

Clean Nginx Server Cache

To clean the whole Nginx server cache, run the following command.

/usr/local/eenos/scripts/cachepurge --nginx

Clean OpenLiteSpeed Cache

To clean the whole OpenLiteSpeed cache, run the following command.

/usr/local/eenos/scripts/cachepurge --ols

Purge Domain  Cache

To clean the cache on  a website, run the following command

/usr/local/eenos/scripts/cachepurge -d <domain>

Purge URL Cache

To clean the cache on a specific website url, use the following command

/usr/local/eenos/scripts/cachepurge -u <url>

certbotinstall

Let's Encrypt Installer

This tool will install or update the Let's Encrypt certbot tool on your server. This tool is required to enable an auto ssl certificate for domains and services.

The eenos installer will automatically set up this during the installation time.

Command:

/usr/local/eenos/scripts/certbotinstall

This is the free ssl certificate provider application in the EEnos control panel.

Wildcard free ssl certificate is not supported yet

eenosavscanner

Antivirus Scanner Tool

This command line tool will help to scan the files of an eenos account. This tool uses the ClamAV antivirus scanner to scan the files.

You may need to install ClamAV before using this tool

Command:

/usr/local/eenos/scripts/eenosavscanner

Command Options:

/usr/local/eenos/scripts/eenosavscanner <enos user>
Usage: 
    /usr/local/eenos/scripts/eenosavscanner  <eenos user>
    /usr/local/eenos/scripts/eenosavscanner  <eenos user1>,<eenos user2>

Scan Single User

To scan a single eenos account,  use the following command

/usr/local/eenos/scripts/eenosavscanner  <eenos user>

Scan Multiple Users

To scan multiple users on the eenos server, use a comma to separate user names. The command is as follows,

/usr/local/eenos/scripts/eenosavscanner  <eenos user1>,<eenos user2>

ftpquotaupdate

Update FTP Quota Usage

This is the ftp disk quota usage update tool.  This tool can be used to update ftp disk usage of eenos accounts or virtual ftp accounts.

In eenos automatic daily quota update timer server is enabled, pure-ftpd-quotacheck.service

Command

/usr/local/eenos/scripts/ftpquotaupdate

Command Options:

Usage: /usr/local/eenos/scripts/ftpquotaupdate  <options>=[values]

Command Groups:
Options:
    --updateall                                 -   To update all users  ftp quota
    --updateuser <eenos user>                   -   To update ftp quota of a single eenos user 
    												and its ftp accounts
    --updatevuser <virtual ftp user account>    -   To update ftp quota of a virtual ftp account

Update  All Account FTP Quota

To update all accounts' ftp quota, use the following command

/usr/local/eenos/scripts/ftpquotaupdate --updateall

Update Eenos User FTP Quota

To update ftp quota of the eenos system user account, use the following command.

/usr/local/eenos/scripts/ftpquotaupdate --updateuser <eenos user>

Update Virtual FTP Account Quota

To update a virtual ftp account disk quota usage, please use the following command.

/usr/local/eenos/scripts/ftpquotaupdate --updatevuser <virtual ftp user account>

hostnamesslinstall

Hostname and Service SSL Installer

This tool will install the Let's encrypt ssl certificate for the hostname and services of your server like webserver, Eenosd,  Exim, dovecot,  etc. This is the default certificate that will be used by these services.

Command:

/usr/local/eenos/scripts/hostnamesslinstall

A commercial SSL certificate can be installed from the WAP control panel.

If your server has a commercial certificate, this tool will use the installed certificate for services.

httpdmodmanger

Apache HTTPD Module Manager

This tool can be used to manage modules on the Apache httpd server.  

Improper usage of the modules may break your web server. You can use this only if you are an expert in HTTPD server.

Command:

/usr/local/eenos/scripts/httpdmodmanger

Command Options:

Usage: /usr/local/eenos/scripts/httpdmodmanger  <options>=[values]

Command Groups:
Options:
    -l , --list                  -   List all httpd modules 
    -e, --enable [module name]   -   To Enable a module
    -d, --disable [module name ] -   To disable a module 

List all HTTPD Modules

To see all available HTTPD modules, use the following command.

/usr/local/eenos/scripts/httpdmodmanger -l

Enable  a Module

To enable a module on Apache httpd, use the following command.

/usr/local/eenos/scripts/httpdmodmanger -e [module name]

Disable a Module

To disable a module from the httpd server, use the following command

/usr/local/eenos/scripts/httpdmodmanger -d [module name ]

It is recommended to manage the MPM modules ( prefork, Worker, and Event ) from the WAP control panel.

installautosslfordomain

Domain Auto SSL Installer

This tool will install the Let's Encrypt free auto ssl certificate for a website or all websites of an eenos account. 

If the domain has a commercial certificate,  priority will be given to that certificate and skip the free ssl certificate.

Users can manage all types of ssl certificates from the UAPP control panel.

See the command and options below,

Command:

/usr/local/eenos/scripts/installautosslfordomain

Command Options:

Usage: /usr/local/eenos/scripts/installautosslfordomain  <options>=[values]

Command Groups:
Options:
    --domain=<domain name>      - The domain name that need ssl
    --user=<eenos user >        - Setup ssl for all domains on a user
    

Setup Domain Auto SSL

To install an auto ssl certificate on a website, use the following command,

/usr/local/eenos/scripts/installautosslfordomain --domain=<domain name>

Setup Auto SSL  For all Domain of a User

To install the Let's Encrypt auto ssl certificate for all websites under an eenos user, please use the following command.

/usr/local/eenos/scripts/installautosslfordomain --user=<eenos user >



ipalias

Manage IP Services

This is a tool to manage IP services in your eenos server. This tool is already installed as a systemd service. All additional IPs will be automatically  activated during the reboot time. 

This tool is used to manage IPs added via the WAP control panel only.

This tool can be used by a system administrator to restart IP services.

Command:

/usr/local/eenos/bin/ipalias

Command Options:

Usage: /usr/local/eenos/bin/ipalias  <options>

Options:
    start       -   To start all ips both ipv4 and ipv6
    stop        -   To stop all ips both ipv4 and ipv6
    restart     -   To restart all ips both ipv4 and ipv6
    startv4     -   To start all ipv4 ips 
    stopv4      -   To stop all ipv4 ips
    restartv4   -   To restart all ipv4 ips
    startv6     -   To start all ipv6 ips 
    stopv6      -   To stop all ipv6 ips
    restartv6   -   To restart all ipv6 ips

Start, Stop, and Restart All IPs ( Both V4 and V6)

To start  all IPs, use the following command

/usr/local/eenos/bin/ipalias start

To stop all IPs, use the following command

/usr/local/eenos/bin/ipalias stop

To restart all IPs, use the following command

/usr/local/eenos/bin/ipalias restart

IPv4 ( Start, Stop, Restart )

You can start, stop, and restart  IPV4 IPs using this tool.

To start  all IPv4 IPs only, use the following command

/usr/local/eenos/bin/ipalias startv4

To stop  all IPv4 Ips only, use the following command

/usr/local/eenos/bin/ipalias stopv4

To restart all IPv4 IPs only, use the following command

/usr/local/eenos/bin/ipalias restartv4

IPv6 ( Start, Stop, Restart )

You can start, stop and restart  IPV6 ips only, by using this tool

To start  all IPv6 IPs only, use the following command

/usr/local/eenos/bin/ipalias startv6

To stop  all IPv6 IPs only, use the following command

/usr/local/eenos/bin/ipalias stopv6

To restart all IPv6 IPs only, use the following command

/usr/local/eenos/bin/ipalias restartv6

quicklogin

Quick Login URL Creator

Generate a quick login url to the WAP, RAPP, and UAPP control panel interface, so that you can log in without using the user name or password.

Command:

/usr/local/eenos/scripts/quicklogin

Command Options:

Usage: /usr/local/eenos/scripts/quicklogin  <options> <value>

Command Groups:
Options:
    --root,-r                        -   Create WAP root login url
    -u <user> , --user <user>        -   Create UAPP user login url
    -re <user> , --reseller <user>   -   Create  RAPP reseller login url

Create a WAP Login URL

To create the WAP control panel login URL, please use the following command

/usr/local/eenos/scripts/quicklogin -r

Create RAPP Login URL

To create  RAPP, Reseller Control panel login URL, use the following command

/usr/local/eenos/scripts/quicklogin --reseller <user>

The <user> must be a reseller account.

Create UAPP Login URl

To create a UAPP, User control panel login url, use the following command

/usr/local/eenos/scripts/quicklogin -u <user>

The <user> must be an eenos end user.

rebuildcrontab

Rebuild the Crontab Of the User

To rebuild eenos users' crontab files,  this tool will auto-generate eenos users crontab files.  The crontab file will be generated by the crons added via the UAP Control panel interface.

If you add a manual cronjob in the users' crontab file, it will be lost along with the rebuild process. We recommend adding cronjobs via the UAPP control panel.

Command:

/usr/local/eenos/scripts/rebuildcrontab

Command Options:

Usage: /usr/local/eenos/scripts/rebuildcrontab  <options> <values>

Command Groups:
Options:
    -a, --all                                 -   To update all users crontab
    -u <eenos user>                           -   To update crontab of a single eenos user 

Reset All Users' Crontabs

To rebuild all users' crontab, run the following command

/usr/local/eenos/scripts/rebuildcrontab -a

It is dangerous to run this command.

Rebuild a User Crontab

To rebuild a single-user crontab, use the following command

/usr/local/eenos/scripts/rebuildcrontab  -u <eenos user> 

here  <eenos user> is the eenos system user name.

Remember, always add Cron jobs via the UAPP  Control  Panel interface.

rebuilddnszone

Rebuild DNS Zones

This tool will help you to rebuild all  DNS zones on the server. You can also rebuild a single domain zone or the user's zones.

Command:

/usr/local/eenos/scripts/rebuilddnszone

Command Options:

Usage: /usr/local/eenos/scripts/rebuilddnszone  <option> | <option>=<choice>
Command Groups:
Options:    
    --all  -  To rebuild all dns zone files in the server and add to dns
    --update_conf_from_zones -  To rebuild dns configuration form zone files
    --user=<user>`- To rebuild all dns zones of a user
    --domain=<domain name> - To rebuild dns zone of domain  

Rebuild  All Zones

To rebuild all dns zones in the server, use the following command.

/usr/local/eenos/scripts/rebuilddnszone --all

Rebuild users's Zones

To rebuild the DNS zone of a single user,  run the following command.

/usr/local/eenos/scripts/rebuilddnszone --user=<user>

Rebuild Domain DNS Zone

To rebuild a domain dns zone, run the following command

/usr/local/eenos/scripts/rebuilddnszone --domain=<domain name>

rebuildvhost

Rebuild Virtual Hosts

This tool will rebuild the virtual host settings of a  website on your web servers.  This tool will rebuild HTTPD, Nginx, OpenliteSpeed, and Varnish Virtual hosts.

Command

/usr/local/eenos/scripts/rebuildvhost

Command Options:

Usage: /usr/local/eenos/scripts/rebuildvhost   <options>[=][value]

Command Groups:
Options:
    --domain=[domain name ]         - Rebuild vhost of a domain
    --user=[user name ]             - Rebuild all vhosts of a user
    -a, --all                       - Rebuild all vhosts 
    -u <user>, --user <user>        - Rebuild all vhosts of a user
    -d <domain>, --domain <domain>  - Rebuild a domain vhost 

Rebuild All Vhosts

To rebuild all virtual hosts in your server, run the following command.

/usr/local/eenos/scripts/rebuildvhost -a

Rebuild User Vhosts

To rebuild all virtual hosts of a single user on your eenos server, use the following command.

/usr/local/eenos/scripts/rebuildvhost -u <user>

where <user> is the eenos hosting control panel user.

Rebuild Domain Vhost

To rebuild the virtual host of a domain, use the following command,

/usr/local/eenos/scripts/rebuildvhost -d <domain>

where <domain> is the website name.

removeacct

Delete Eenos User & Reseller

This tool will help you to remove an eenos account from the server. You can remove a single user or a reseller. 

Deleting Reseller will remove all the subaccounts.

Removing an account will remove every data associated with that account. This operation is irreversible. 

Command

/usr/local/eenos/scripts/removeacct

Command Options:

usage: removeacct [-h] (--user USER | --reseller RESELLER)

Mange user and reseller termination and removal operation

optional arguments:
  -h, --help            show this help message and exit
  --user USER, -u USER  Eenos user name to terminate
  --reseller RESELLER, -r RESELLER
                        Eenos reseller name to terminate. This will remove reseller and sub accounts

Remove Eenos User

To remove the eenos user and all the data of that user, use the following command

/usr/local/eenos/scripts/removeacct -u USER

where USER is the eenos user name.

Remove Reseller

To delete a reseller account and all sub-accounts, use the following command

/usr/local/eenos/scripts/removeacct -r RESELLER

where RESELLER is the eenos reseller account name.


restoreacct

Restore Eenos Backup

This tool will help you to restore backup generated from an eenos hosting control panel.  You can restore the entire backup or a part of the backup like files, email, database, etc. 

If you are restoring a full backup and the account exists in the server, it will only overwrite the data. If you wish to do a full clean restore, remove the account from the server before restoring.

Command:

/usr/local/eenos/scripts/restoreacct PATH_TO_BACKUP

where PATH_TO_BACKUP is the full path to the backup file.

Command Options:

usage: restoreacct [options] PATH_TO_BACKUP 

Restore backup of eenos hosting account. By Default restore full backup

Required:
  PATH_TO_BACKUP        Full path to Eenos backup

Option(s):
  -h, --help            show this help message and exit
  --log                 Create a custom log file

Restore Type:
  --full                Restore full account. This is default option
  --home                Restore home directory
  --domain DOMAIN       Restore a website content
  --email EMAIL         Restore an email account
  --mysqldb MYSQLDB     Restore a MySQL database
  --pgsqldb PGSQLDB     Restore a PgSQL database
  --mongodb MONGODB     Restore a MongoDB database
                         
  --file FILE           Restore a single file. The file path need to be
                        relative to homedir
                        Example : public_html/foo/fun.php
                         
  --dir DIR             Restore a folder. The directory path need to be
                        relative to homedir
                        Example : public_html/foo 

Full account restore option(s):
  --disk_mount DISK_MOUNT
                        The disk mount point to create home directory.
                        By default use the home directory from backup.
                        (Example : /home2)
                         
  --ipv4 IPV4           Assign a dedicated IPv4 address.
                        By default use the main shared IP address or
                        the IP address from the backup, if exists
                         
  --newname NEWNAME     Restore backup into new eenos user name
                        This will rename the home directory and database names.
                        WARNING !!! : The websites may stop working due to the
                        change in storage path and database names 
                         
  --skipname            Use the same user name from the backup
                        By default enabled
                         
  --force               Force restore if account exist in server.
                        This will replace the data only.
                         
  --skipmysql           Exclude MySQL database(s) restore 
  --skiphome            Exclude Homedir restore 
  --skiplets            Exclude Lets encrypt auto ssl restore 
  --skippgsql           Exclude PgSQL database(s) restore
  --skipmongodb         Skip Mongodb database(s)  restore
  --skipmailman         Exclude Mailman3 mailing list  backups
  --skipemail           Exclude email accounts restore
  --skipbwdata          Exclude bandwidth usage history
  --skipdiskusage       Exclude disk usage history
  --skippublichtml      Exclude public_html folder restore
  --skipreseller        Exclude reseller privileges

Restore Full Account

To restore a full account, you may use the following command.

/usr/local/eenos/scripts/restoreacct --full PATH_TO_BACKUP

where PATH_TO_BACKUP is the location path to the backup file.  The PATH_TO_BACKUP may be a .tar  or  .tar.gz  file, or a  folder containing  backup of the account.

You can also  use the following options along with full restore  options.

Full Restore Options

This option will make changes or data exclude operations during backup restore process.

--disk_mount

This option will be used to assign a new home directory path for the restoring account.

By default, use the home directory mentioned in the backup file.

Command:

/usr/local/eenos/scripts/restoreacct --disk_mount DISK_MOUNT PATH_TO_BACKUP

where DISK_MOUNT  is the new home  ( Example:  /home2)  

--ipv4

This option will change the  IPV4 address of the account by assigning the new IP address. If the given IP does not exist or is not available, the process will use the main shared IPv4 address of the account. 

By default, the restore process will use the IP from the backup and if the IP is not available, it will use the main shared IP.

Command:

/usr/local/eenos/scripts/restoreacct --ipv4 IPV4 PATH_TO_BACKUP

where IPV4 is the free IP available on the server.

--newname

Change the eenos user name with a new user name.  This option will assign a new user name for the restoring hosting accounts.

These options will change database name prefixes and home directory name, which may break some websites or applications that are already configured inside the hosting account. You may need to manually edit the website scripts to fix the new paths and database names. You are Warned !!!

Command:

/usr/local/eenos/scripts/restoreacct --newname NEWNAME PATH_TO_BACKUP

where NEWNAME is a Unix user name for the new eenos hosting account.

--force

Use this option, if the account already exists in the server. 

If the account exists, it will replace the data only. This doesn't provide a  clean full restore action.

You may use the following command to force the restore.

/usr/local/eenos/scripts/restoreacct --force PATH_TO_BACKUP
--skipmysql

To skip restoring all MySQL databases from the backup,

Command:

/usr/local/eenos/scripts/restoreacct --skipmysql PATH_TO_BACKUP
--skiphome

To skip the home directory restore of the account,

Command:

/usr/local/eenos/scripts/restoreacct --skiphome PATH_TO_BACKUP
--skiplets

To skip regeneration of Let's encrypt auto ssl certificates,

Command:

/usr/local/eenos/scripts/restoreacct --skiplets PATH_TO_BACKUP
--skippgsql

To  exclude PostgreSQL database restore from the backup, 

Command:

/usr/local/eenos/scripts/restoreacct --skippgsql PATH_TO_BACKUP
--skipmongodb

To exclude Mongodb database restore from the backup,

Command:

/usr/local/eenos/scripts/restoreacct --skipmongodb  PATH_TO_BACKUP
--skipmailman

This is a future option. Restoring and backup of the Mailman3 mailing list is not supported yet. 

--skipemail

To exclude restoring email accounts from the backup,

Command:

/usr/local/eenos/scripts/restoreacct --skipemail PATH_TO_BACKUP
--skipbwdata

To exclude bandwidth usage  data history from the backup,

Command:

/usr/local/eenos/scripts/restoreacct --skipbwdata PATH_TO_BACKUP
--skipdiskusage

To exclude disk usage history data from the backup,

Command:

/usr/local/eenos/scripts/restoreacct --skipdiskusage PATH_TO_BACKUP
--skippublichtml

To exclude the public_html folder, (it   is  the document root of the main account),

Command:

/usr/local/eenos/scripts/restoreacct --skippublichtml PATH_TO_BACKUP
--skipreseller

Exclude the reseller privileges on the account if have them.

If the backup is a reseller account backup, the restore operation will restore the reseller privileges as the default restore option.

Command:

/usr/local/eenos/scripts/restoreacct --skipreseller PATH_TO_BACKUP

Restore Home Directory From Backup

The eenos restore tool has this unique feature to restore home directory files from  the backup. This may include everything inside the home directory.

Command:

/usr/local/eenos/scripts/restoreacct --home PATH_TO_BACKUP

Restore Domain or Website

Restore website content from the backup. You can restore full website files from a backup. 

Command:

/usr/local/eenos/scripts/restoreacct --domain DOMAIN PATH_TO_BACKUP

where DOMAIN is the website name.

Restore Email Account

You can restore a single email account from the backup. 

If the email account already exists, it will sync the emails.

Command:

/usr/local/eenos/scripts/restoreacct --email EMAIL PATH_TO_BACKUP

where EMAIL is the email account name.

Restore MySQL Database 

You can restore a single  MySQL database from the backup.

Command:

/usr/local/eenos/scripts/restoreacct --mysqldb MYSQLDB PATH_TO_BACKUP

where MYSQLDB is  MySQL database name.

Restore PostgreSQL Database 

You can restore a single  PostgreSQL database from the backup.

Command:

/usr/local/eenos/scripts/restoreacct --pgsqldb PGSQLDB PATH_TO_BACKUP

where PGSQLDB is the  PgSQL database name.

Restore MongoDB Database 

You can restore a single  MongoDB database from the backup.

Command:

/usr/local/eenos/scripts/restoreacct --mongodb MONGODB PATH_TO_BACKUP

where MongoDB is the MongoDB database name.

Restore File

You can restore a single file from the backup. To restore the file, use the following command

Command

/usr/local/eenos/scripts/restoreacct --file FILE PATH_TO_BACKUP

where FILE is the relative path to the file from the  user's home directory ( eg: public_html/foo/fun.php )

Restore the Directory or Folder

You can restore a single directory or folder from the backup.

Command:

/usr/local/eenos/scripts/restoreacct --dir DIR PATH_TO_BACKUP

where DIR is the relative path to the directory from the user's home directory ( Ex: public_html/foo )

suspendacct

Suspend Eenos Accounts

You can suspend an eenos user account or reseller account from the server terminal. Suspending the account will disable the account to get into the server and websites of the suspended account.

Suspending a reseller account will suspend the reseller account and sub-accounts.

Command:

/usr/local/eenos/scripts/suspendacct

Command Options:

usage: suspendacct [-h] (--user USER | --reseller RESELLER) --reason REASON

Mange user and reseller suspend operations

optional arguments:
  -h, --help            show this help message and exit
  --user USER, -u USER  Eenos user name to suspend
  --reseller RESELLER, -r RESELLER
                        Eenos reseller name to suspend. This will suspend reseller and sub accounts
  --reason REASON       Reason for suspending the account

Suspend User

To suspend the eenos user account, use the following command 

/usr/local/eenos/scripts/suspendacct --user USER --reason REASON

where USER is the eenos user name and REASON is the reason for suspend action.

Example:  Suspend eenos user "foo" for the reason "non payment"

/usr/local/eenos/scripts/suspendacct --user foo --reason "non payment"

Suspend Reseller

To suspend a reseller, use the following command.

/usr/local/eenos/scripts/suspendacct --reseller RESELLER  --reason REASON

where RESELLER is the eenos reseller and REASON is the reason for suspension.

unsuspendacct

Unsuspend Accounts

You can un-suspend eenos user accounts and resellers from the server terminal.

Unsuspending reseller accounts may unsuspend all subaccounts also.

Command:

/usr/local/eenos/scripts/suspendacct

Command Options:

usage: unsuspendacct [-h] (--user USER | --reseller RESELLER)

Mange user and reseller unsuspend operations

optional arguments:
  -h, --help            show this help message and exit
  --user USER, -u USER  Eenos user name to unsuspend
  --reseller RESELLER, -r RESELLER
                        Eenos reseller name to suspend. This will unsuspend reseller and sub accounts

Unsuspend User

To un-suspend an eenos user's account, please use the following command.

/usr/local/eenos/scripts/unsuspendacct --user USER

where USER is the eenos user name.

UnSuspend Reseller  

To unsuspend the reseller account, use the following command 

/usr/local/eenos/scripts/unsuspendacct --reseller RESELLER

where RESELLER is the eenos reseller name.


sanboxpython

SanBox Python Apps

Install and manage per-site-based Python apps and modules. This tool will provide a virtual multi-python and module manager for a website.

The SanBox python application can be managed by the UAPP control panel in a Multi python server. 

You may need to set up Muti Python to enable this feature.

Eenos is the first control panel that provides the SanBox python application with an easy user-friendly deployment interface for hosting users.

This command line tool is a server administrator tool.

Command:

/usr/local/eenos/scripts/sanboxpython

Command Options:

Usage: /usr/local/eenos/scripts/sanboxpython <option>  [value]

Command Groups:
Options:   
    -i <domain> <python version>  :  To install a specific python sanbox for a domain
    -r <domain>                   : To remove the python sandbox of a domain
    -ri <domain>                  : Re install python sandbox on domain
    -pi <domain> <pips>           : Install or Upgrade pips on domain
    -pr <domain> <pips>           : Remove  pips  from domain

Install SanBox Python On Domain

To setup a   SanBox python environment  on a website, use the following  command,

/usr/local/eenos/scripts/sanboxpython -i <domain> <python version>

Example:  To setup python 3.10 sanbox environment on a domain foo.com use the following command 

/usr/local/eenos/scripts/sanboxpython -i fooo.com eenos-python39

To find all Python versions, you may use the  Setuppython Tools

Remove SanBox Python from a Domain

To uninstall  the python sanbox environment from a domain, use the following  command:

/usr/local/eenos/scripts/sanboxpython -r <domain>

where <domain> is the website name.

Install Python Modules, and PiPs on SanBox

You can use this tool to install Python packages from the pip repository using the following command.

/usr/local/eenos/scripts/sanboxpython -pi <domain> <pips>

where <domain> is the website and <pips> is a comma-separated list of Python module names.

Eenos users can manage the Python modules from the UAPP Control panel interface.

Uninstall Python Modules, PIPs on SanBox

To remove Python modules from a SanBox domain, use the following command,

/usr/local/eenos/scripts/sanboxpython -pr <domain> <pips> 

where <domain> is the website name and <pips> is the comma-separated list of Python modules.

sanboxruby

SanBox Ruby and Ruby on Rails  Apps

Install and manage per site-based ruby apps and gems. This tool provides a virtual multi-ruby and gem manager for a website.

The SanBox Ruby applications can be managed by the UAPP control panel in a Multi Ruby server. 

You may need to set up Muti Ruby to enable this feature.

Eenos is the first control panel that provides SanBox Ruby applications with an easy user-friendly deployment interface for hosting users.

This command line tool is a server administrator tool.

Command:

/usr/local/eenos/scripts/sanboxruby

Command Options:

Usage: /usr/local/eenos/scripts/sanboxruby <option>  [value]

Command Groups:
Options:   
    -i <domain> <ruby version>      :   To install a specific ruby sanbox for a domain
    -id <domain> <ruby version>     :   Install ruby sandbox and setup demo rails app
    -ri <domain>                    :   Re install Ruby sandbox on domain
    -r <domain>                     :   To remove the ruby sandbox of a domain
    -gs <domain> <action> <gems>    :   To install,update or uninstall Ruby gems on domain

Install SanBox Ruby On Domain

To setup a virtual ruby environment  on a domain, run the following command

/usr/local/eenos/scripts/sanboxruby -i <domain> <ruby version> 

Example:  To setup the Ruby 3.1 Sanbox environment on a domain foo.com use the following command 

/usr/local/eenos/scripts/sanboxruby -i foo.com eenos-ruby31

To find all ruby versions, you may use the  Setupruby Tools.

Remove SanBox Ruby From a Domain

To uninstall the ruby environment from a server, use the following command 

/usr/local/eenos/scripts/sanboxruby -r <domain>

where <domain> is the website name.

Manage Ruby Gems

To install, update, or uninstall Ruby gem modules, use the following command,

/usr/local/eenos/scripts/sanboxruby -gs <domain> <action> <gems>

where <domain> is the website name 

<action> is  install, update, or uninstall, 

<gems> is the command-separated list of gem module names

Eenos users can manage the gem modules from the UAPP Control panel interface.

sanboxnodejs

SanBox NodeJS Apps

Install and manage per-site-based NodeJs apps and npm modules. This tool will provide a virtual multi-NodeJs and module manager for a website.

The SanBox NodeJs application can be managed by the UAPP control panel in a multi-NodeJS server. 

You may need to set up Muti NodeJs to enable this feature.

Eenos is the first control panel that provides the SanBox NodeJs application with an easy user-friendly deployment interface for hosting users.

This command line tool is a server administrator tool.

Command:

/usr/local/eenos/scripts/sanboxnodejs

Command Options:

Usage: /usr/local/eenos/scripts/sanboxnodejs <option>  [value]

Command Groups:
Options:   
    -i <domain> <nodejs version>        :   To install a specific NodeJs sanbox for a domain
    -r <domain>                         :   To remove the NodeJs sandbox of a domain
    -ri <domain>                        :   Re install NodeJs sandbox on domain
    -ns <domain> <action> <packages>    :   To install,update or uninstall npm packages

Install SanBox NodeJs On Domain

To set up a   SanBox  NodeJs environment on a website, use the following command,

/usr/local/eenos/scripts/sanboxnodejs -i <domain> <nodejs version> 

where <domain> is the website name and <nodejs versions> is the required nodejs version.

Example:  To set up  NdoeJS 18  sanbox environment on a domain foo.com use the following command 

/scripts/setupnodejs -i foo.com eenos-nodejs18

To find all NiodeJS versions, you may use the  Setupnodejs Tools.

Remove SanBox  NodeJS From the Domain

To uninstall sanBox nodejs version from a domain, use the following command,

/usr/local/eenos/scripts/sanboxnodejs -r <domain>

where <domain> is the website name.

Manage Npm Packages

To install, update, or uninstall NPM packages, use the following command,

/usr/local/eenos/scripts/sanboxnodejs -ns <domain> <action> <packages> 

where <domain> is the website 

<action> is install, update or uninstall

<packages> is a comma-separated list of NPM packages

Eenos users can manage the npm modules from the UAPP Control panel interface.

eenoslicense

Eenos License Troubleshoot 

To manage and update the eenos license from the eenos server terminal.

This is a simple tool to check your eenos control panel license and update the license key.  Eenos uses an IP-based license system. Eenos license supports both IPv4 and IPv6 IPs.

If your server has both  IPv4 and Ipv6 IPs, the license will be issued for the IPv4  address.

Command:

/usr/local/eenos/bin/eenoslicense

Command Options:

/usr/local/eenos/bin/eenoslicense <option>
Command Groups:
Options:

    -ip, --mylicenseip  -   Show your license IP address
    -i, --init          -   Initialize a request for license
    -u, --update        -   Update License 
    -c, --check         -   Check License

Find  Eenos License IP

The first step is to find the eenos license IP. To find your eenos license IP  run the following command in server ssh terminal.

/usr/local/eenos/bin/eenoslicense -ip

This command will show your  Ip address for Eenos license activation. Then,  you need to activate the eEnos license for this IP from your client area on our website or your license management portal.

Activate Eenos License

You need to activate the  Eenos license for the above-seen IP address from your client area with us or your license purchaser portal or license management portal. Eenos provides two types of Licenses.

  1.  VPS
  2. DEDICATED

License Types

Eenos provides two types of licenses.

VPS

This is for VPS  /Containers / Cloud VMS. This license can only run on virtual operating systems.

These licenses will get default technical support.

DEDICATED

This license can be used on both dedicated and VPS servers including bare metal, cloud servers, etc. This is our premium license and you will get priority technical support for the dedicated licenses.

Init License Request

This is required only once, it will be automatically initialized during the control panel installation. If you change your server License IP or reissue the license, then you need to initialize the license as follows from the server terminal.

/usr/local/eenos/bin/eenoslicense --init

Example:

/usr/local/eenos/bin/eenoslicense --init
Starting License Initialization
License System ID : 145d78e5-a18a-44b1-952e-15e27f3a6617
Your Public ip : 2a01:xxxx:0xxx:xxxx:0000:0000:0000:0xxx
License already initialized

Check License From Server

To check the license  from the server, use the following command,

/usr/local/eenos/bin/eenoslicense -c

Example 

usr/local/eenos/bin/eenoslicense -c
Verifying Eenos License
License IP   : 2a01:xxxx:xxxx:xxxx:0000:0000:0000:xxxx
License ID   : bd223039-cb1e-4375-97bb-aea1aebccba8
Created On   : 2022-12-07
Updated On   : 2022-12-07
License Type : DEDICATED
License OK

Verify License Online

You can verify the eenos license online from  the website verify.eenos.com 

Update License Cache

Eenos license cache is valid for  2 to 4 weeks. So it will automatically fetch the license keys and store them in your server.  Your server doesn't need to communicate with eenos servers for work if the license is expired or invalid.

To  manually update the license cache in your server, run the following command,

/usr/local/eenos/bin/eenoslicense -u


backupctl

Tool to manage Eenos Scheduled Backups

Manage scheduled backups from the server command line.

Command :

/usr/local/eenos/scripts/backupctl

Command Options:

usage: backupctl [options]

Restore or Manage eenos scheduled backups.

Command(s):
  -l, --list            List all backups
  -s key_word, --search key_word
                        Search on backup database. You can use the keywords
                        like schedule id, pool id,  eenos user name
  -r backup_id, --restore backup_id
                        Restore a backup ID
  -do backup_id, --download backup_id
                        Download backup from backup ID

Restore Options:
  --full                Restore full account. This is default option
  --home                Restore home directory
  --domain DOMAIN       Restore a website content
  --email EMAIL         Restore an email account
  --mysqldb MYSQLDB     Restore a MySQL database
  --pgsqldb PGSQLDB     Restore a PgSQL database
  --mongodb MONGODB     Restore a MongoDB database
                         
  --file FILE           Restore a single file. The file path need to be
                        relative to homedir
                        Example : public_html/foo/fun.php
                         
  --dir DIR             Restore a folder. The directory path need to be
                        relative to homedir
                        Example : public_html/foo 

Download Option(s):
  -st path_to_store, --saveto path_to_store
                        A folder location to download and store the backup

Option(s):
  -h, --help            show this help message and exit
  -d, --demon           Run restore as daemon service

List All Backups

To list all available scheduled backups in the Eenos server, use the following command.

/usr/local/eenos/scripts/backupctl -l

Search Backups

/usr/local/eenos/scripts/backupctl -s  KEY_WORD

The KEY_WORD can be the backup ID, user name, backup type, owner, or storage pool name

Download Backup to Server

You can download a backup from the remote storage pool using the following command.

/usr/local/eenos/scripts/backupctl --download backup_id

The backup_id is the id of the backup. ( Eg:  13690965-40b4-47b3-9ef9-d535414c2fa6 )

Download Option

You can set a store location of the above-downloaded path using the  option  --saveto , sample command is as follows,

/usr/local/eenos/scripts/backupctl --download backup_id --saveto path_to_store

Where backup_id is the id of the backup and  path_to_store is a folder name in the server to store the downloaded backups.

Restore A Scheduled Backup

To restore a scheduled backup from the command line use the following command.

/usr/local/eenos/scripts/backupctl --restore backup_id

The backup_id is the id of the backup. ( Eg:  13690965-40b4-47b3-9ef9-d535414c2fa6 )

Restore Options

You can restore a backup fully or part of the backup. The following restore options are available.

Rune Restore in Server Background

You can run the restore option as a daemon service on the server background using the  following command  flag -d or --demon

poolctl

Backup Storage Pool Operations

This command will help you to perform some basic backup storage pool operations on the server.

Command :

/usr/local/eenos/scripts/poolctl

Command Options :

usage: poolctl [command] [command options]  

Eenos backup storage pool utility

Option(s):
  -h, --help            show this help message and exit

Command(s):
  -t pool_id, --test_pool pool_id
                        Test storage pool connection
  -l, --list            List storage pools

Command Options(Required):
  --root, -r            Root storage pool operations
  --reseller RESELLER, -re RESELLER
                        Reseller storage pool operations
  --user USER, -u USER  User storage pool operations

Pool Owner Operations.

You need to use the pool owner potion  --root, --reseller, or --user with all of these commands. So that those operations will be performed for the specific user.

List Pool

To list all  storage pools of  a user  ( root, reseller, or user )  use the following command,

/usr/local/eenos/scripts/poolctl -l USER

Where USER will be --root , --reseller or --user

Example 1:  List all storage pools of root or wap, use the following command

/usr/local/eenos/scripts/poolctl -l --root

Example 2:  List all storage pools of a reseller account,  myreseller, use the following command,

/usr/local/eenos/scripts/poolctl -l --reseller myreseller

Example 3:  List all storage pools of a user, myuser , use the following command

/usr/local/eenos/scripts/poolctl -l --user myuser

Test Pools Connection

This command will do a connection test to the storage pools.

/usr/local/eenos/scripts/poolctl -t pool_id  USER 

Where pool_id is the id of the pool and USER will be --root, --reseller, or --user

Example 1: Test pool connection for pool id 4ae130bb-d8a1-4b58-bed4-e412e504aefc for the user  root

/usr/local/eenos/scripts/poolctl -t 4ae130bb-d8a1-4b58-bed4-e412e504aefc --root

Example 2: Test pool connection for  pool id  99d8c43f-1aa7-4285-b990-217b376c1970 for reseller  myreseller

/usr/local/eenos/scripts/poolctl -t 99d8c43f-1aa7-4285-b990-217b376c1970 --reseller myreseller

Example 3:  Test storage pool connection for pool id 1df89ef8-e8ec-4b36-b158-0b1d08b25cc6 for user  myuser

/usr/local/eenos/scripts/poolctl -t 1df89ef8-e8ec-4b36-b158-0b1d08b25cc6 --user myuser

It is always recommended to test the storage pool connection  using the commands from the server terminal.

Testing storage pool connections from the web interface only tests the tcp port connections.

schedulectl

Manage Backup Schedule

This command can be used to manage scheduled jobs from the server terminal

Command :

/usr/local/eenos/scripts/schedulectl

Command Options :

usage: schedulectl [command] [command options]  

Eenos backup schedule utility

Option(s):
  -h, --help            show this help message and exit

Command(s):
  -rb, --rebuild        Rebuild schedule cron jobs
  -l, --list            List schedules

Command Options(Required):
  --root, -r            Root backup schedule operations
  --reseller RESELLER, -re RESELLER
                        Reseller backup schedule operations
  --user USER, -u USER  User schedule operations

Schedule Owner Operations

You need to use the pool owner potion  --root, --reseller, or --user with all of these commands. So that those operations will be performed for the specific user.

List Backup Schedules

To list backup schedules use the following command 

/usr/local/eenos/scripts/schedulectl -l USER

Where USER will be --root , --reseller or --user

Example 1: List schedules of root user or wap

/usr/local/eenos/scripts/schedulectl -l --root

Example 2: List backup schedules of reseller, myreseller

/usr/local/eenos/scripts/schedulectl -l --reseller myreseller

Example 3: List backup schedules of the user, myuser

/usr/local/eenos/scripts/schedulectl -l --user myuser

Rebuild  Schedule Cron Jobs

These schedules are executed using a cron job.  To create the cronjob files for the schedules use the following command.

/usr/local/eenos/scripts/schedulectl --rebuild USER

Where USER will be --root , --reseller or --user

Example 1:  Rebuild schedule crontabs for root or wap

/usr/local/eenos/scripts/schedulectl --rebuild -r

This will create the cronjob file /etc/cron.d/eenosbackup_schedule_wap-root 

You may delete this cronjob file,  /etc/cron.d/eenosbackup_schedule_wap-root if you like to disable all backup schedules from WAP.

Example 2: Rebuild schedule cronjobs for reseller, myreseller

/usr/local/eenos/scripts/schedulectl --rebuild -re myreseller

This will create the cronjob file /etc/cron.d/eenosbackup_schedule_rapp-myreseller

You may delete this cronjob file, /etc/cron.d/eenosbackup_schedule_rapp-myreseller if you like to disable this reseller backup schedule.

Example 3: Rebuild schedule cronjobs for user, myuser

/usr/local/eenos/scripts/schedulectl --rebuild -u myuser

This will create the cronjob file  /etc/cron.d/eenosbackup_schedule_uapp-myuser

You may delete this cronjob file,  /etc/cron.d/eenosbackup_schedule_uapp-myuser , if you like to disable this user backup schedule.