ISPManager

https://www.ispmanager.com/docs
Admin
ISPManager is a web server control panel for managing hosting services, enabling administrators to...
Tokens:297,902
Snippets:4,682
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### OpenLiteSpeed manager-ssl.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example configuration for a listener in manager-ssl.conf.

```text
listener manager-cert-listen {
    address 172.31.97.76:1501
    secure 1
    keyFile /usr/local/mgr5/etc/manager.key
    certFile /usr/local/mgr5/etc/manager.crt
    map Default *
    include /usr/local/lsws/conf/ssl_conf/mapping/*.conf
}
```

--------------------------------

### Install plugin from GitHub

Source: https://www.ispmanager.com/docs/developer-guide/plug-in-example-templates-engine-management

Clone the repository and run the installation script to deploy the plugin.

```bash
git clone https://github.com/ispmanager-official/plugin-examples.git
cd plugin-examples
./install.sh template-nginx-rate-limit
```

--------------------------------

### OpenLiteSpeed manager-map.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example mapping configuration for a virtual host in manager-map.conf.

```text
map manager-cert-vhost site.domain
```

--------------------------------

### Example package.json structure

Source: https://www.ispmanager.com/docs/ispmanager/managing-a-nodejs-project

A complete example of a package.json file showing dependencies and scripts configuration.

```json
{
  "name": "node.com",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node server.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "type": "commonjs",
  "dependencies": {
    "express": "^4.18.3"
  }
}
```

--------------------------------

### Ispmanager site management examples

Source: https://www.ispmanager.com/docs/developer-guide/mgrctl-utility

Examples for listing and modifying web domains in ispmanager.

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain  | sed 's/=/ /' | awk '{print $2}'
```

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain  su=<user>  | sed 's/=/ /' | awk '{print $2}'
```

```bash
for i in $(/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain | awk '{print $1}' | awk -F = '{print $2}'); do /usr/local/mgr5/sbin/mgrctl -m ispmgr domain.fix elid=$i; done
```

```bash
for i in $(/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain | awk '{print $1}' | awk -F = '{print $2}'); do /usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain.edit php=off elid=$i sok=ok; done
```

--------------------------------

### OpenLiteSpeed manager.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example virtual host configuration for a certificate in manager.conf.

```text
virtualHost manager-cert-vhost {
    vhDomain site.domain
    vhRoot Default/
    docRoot Default/html
    context / {
        extraHeaders Header set Strict-Transport-Security "max-age=31536000; preload"
    }
    vhssl {
        keyFile /usr/local/mgr5/etc/manager.key
        certFile /usr/local/mgr5/etc/manager.crt
        certChain 1
    }
    include /usr/local/lsws/conf/vhosts-includes/*.conf
}
```

--------------------------------

### Execute the installation script

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Run the downloaded script to begin the ispmanager installation process.

```bash
sh install.eu.sh
```

--------------------------------

### Install wget utility

Source: https://www.ispmanager.com/docs/ispmanager/installing-cloudlinux-with-os-conversion

Command to install the wget utility if it is missing from the server.

```bash
yum install wget
```

--------------------------------

### Ansible Playbook for CMS Installation

Source: https://www.ispmanager.com/docs/ispmanager/cms-catalog

An example playbook used to automate the installation of a CMS, including directory creation, file downloading, unpacking, and permission management.

```yaml
- hosts: 127.0.0.1
  tasks:
  - name: Create a install directory if it does not exist
    file:
      path: "{{ install_path }}"
      state: directory
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: "0755"
      recurse: yes
  - name: Download bitrix
    get_url:
      url: "http://www.1c-bitrix.ru/download/standard_encode.tar.gz"
      dest: "{{ install_path }}/standard_encode.tar.gz"
      mode: "644"
      timeout: 1800
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
  - name: Unpack bitrix archive
    unarchive:
      src: "{{ install_path }}/standard_encode.tar.gz"
      dest: "{{ install_path }}"
      remote_src: yes
      owner: "{{ user_name }}"
      group: "{{ user_name }}"

  - name: Set the permissions on Bitrix directories
    command: find {{ install_path }} -type d -exec chmod 755 {} \;

  - name: Set the permissions for Bitrix files
    command: find {{ install_path }} -type f -exec chmod 644 {} \;

  - name: Create a directory if it does not exist
    file:
      path: "{{ install_path }}/bitrix/php_interface"
      state: directory
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: "0755"

  - name: copy dbconn.php
    template:
      src: templates/dbconn.php.j2
      dest: "{{ install_path }}/bitrix/php_interface/dbconn.php"
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: 0644

  - name: copy .settings.php
    template:
      src: templates/.settings.php.j2
      dest: "{{ install_path }}/bitrix/.settings.php"
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: 0644

  - name: copy after_connect_d7.php
    template:
      src: templates/after_connect_d7.php.j2
      dest: "{{ install_path }}/bitrix/php_interface/after_connect_d7.php"
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: 0644

  - name: copy after_connect.php
    template:
      src: templates/after_connect.php.j2
      dest: "{{ install_path }}/bitrix/php_interface/after_connect.php"
      owner: "{{ user_name }}"
      group: "{{ user_name }}"
      mode: 0644

  - name: Delete archive
    file:
      path: "{{ install_path }}/standard_encode.tar.gz"
      state: absent
```

--------------------------------

### Requesting module prices

Source: https://www.ispmanager.com/docs/for-partners/reselling-ispmanager-modules-via-api

Example GET request to retrieve module pricing information from partner billing.

```http
https://api.PARTNER_BILLING.com/?func=pricelist.export&itemtype=addition&out=xml
```

--------------------------------

### Apache manager.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example VirtualHost configuration for managing SSL certificates in Apache.

```apache
<VirtualHost 172.31.97.76:1501>
    ServerName localhost
    <IfModule headers_module>
        Header always set Strict-Transport-Security "max-age=31536000; preload"
    </IfModule>
    SSLCertificateFile "/usr/local/mgr5/etc/manager.crt"
    SSLCertificateKeyFile "/usr/local/mgr5/etc/manager.key"
    SSLCipherSuite EECDH:+AES256:-3DES:RSA+AES:!NULL:!RC4
    SSLEngine on
    SSLHonorCipherOrder on
    SSLProtocol TLSv1 TLSv1.1 TLSv1.2
</VirtualHost>
```

--------------------------------

### View cloning operation start log

Source: https://www.ispmanager.com/docs/ispmanager/site-cloning

Example log entry indicating the initiation of a site cloning operation.

```text
Dec 18 07:55:31 [899205:527] action EXTINFO Get message for error in action 'example-clone.com' for level 30
```

--------------------------------

### Download the ispmanager installation script

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Use this command to download the official installation script to your server.

```bash
wget https://download.ispmanager.com/install.eu.sh -O install.eu.sh
```

--------------------------------

### Install MySQL via command line

Source: https://www.ispmanager.com/docs/ispmanager/install-a-database-management-system

Use this command to install the MySQL server from the command line.

```bash
sh ./install.sh --mysql-server mysql
```

--------------------------------

### Install ISPmanager with MySQL

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Installs the latest beta version configured with the MySQL DBMS.

```bash
sh install.eu.sh --mysql-server mysql --release beta ispmanager-lite
```

--------------------------------

### Install MySQL or MariaDB via command line

Source: https://www.ispmanager.com/docs/ispmanager/installing-a-database-management-system

Use these commands during installation to specify the desired database server type.

```bash
sh ./install.sh --mysql-server mariadb
```

```bash
sh ./install.sh --mysql-server mysql
```

--------------------------------

### Install MariaDB via command line

Source: https://www.ispmanager.com/docs/ispmanager/install-a-database-management-system

Use this command to install the MariaDB server from the command line.

```bash
sh ./install.sh --mysql-server mariadb
```

--------------------------------

### Activate license during installation

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-license-activation-and-upgrade

Use this command during the initial installation process to activate the license using a unique key.

```bash
sh install.eu.sh --activation-key KEY
```

--------------------------------

### Apache ssl_vhosts_inc.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example configuration for including certificate-specific virtual host files and setting the listening port.

```apache
IncludeOptional /etc/httpd/ssl_cert_vhosts/*.conf
Listen 1501
```

--------------------------------

### User storage configuration file example

Source: https://www.ispmanager.com/docs/ispmanager/user-backup-storage

Example of the XML configuration file located at /usr/local/mgr5/etc/backup.conf.d/USERNAME.conf used to define storage parameters.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <params>
    <size_limit>3221225472</size_limit>
    <count_limit>7:7</count_limit>
  </params>
  <storage name="main">
    <token>
      <arch_password>DXpc+4KArgISNKcsneCANFA4ZDO9Uc0JhfYrDhkoDj0XnemZP1EtFdVRUaT37C9G1GVpzNItk390EBMegbHzbqU5gm+ESaZ/KsrIKJ0wk8a4G/kFRFr68me4uxp+SelJpLaG1VurDvDwZ6xwkyD1SPCtb3gMmZQYj4TBUj5DH19k9qTVajHPsT1TebEeL+c2iT8P8Pcf7rxV735PWPuqwtdzXLXLaPnyNcSIArmF8FAf8nBA7fmxeqfHh4+eblamCnH26W17MwcIGXDT3xOCYKpfrzy4mL+2SkgeLPh/mjb9+n1Fhn3/rgZ9OIZiUEjfeVkhRZIurTPqpImU/QaFpg==</arch_password>
      <path>/</path>
      <token>YPBlMqjTWtcAAAAAAAAAAZ4c_tIZlPt47XVin264P4BQX2KVaEtDt4ACZg3MJarG$_REFRESH_$</token>
      <type>dropbox</type>
    </token>
  </storage>
</doc>
```

--------------------------------

### Install ISPmanager with minimal software

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Performs a minimal installation of the latest stable ISPmanager 6.

```bash
sh install.eu.sh --release stable ispmanager-lite-common
```

--------------------------------

### Install ISPmanager with license key and LiteSpeed

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Installs the latest stable version using a specific activation key and a trial LiteSpeed web server.

```bash
sh install.eu.sh --release stable ispmanager-lite --activation-key 1234567890-ABCDEFGHIJKLMNOPQRSTUVWXYZ --litespeed TRIAL
```

--------------------------------

### ihttpd configuration file example

Source: https://www.ispmanager.com/docs/ispmanager/control-panel-address-and-ssl-certificates

Example of a basic ihttpd configuration block defining IP addresses and SNI settings.

```text
listen {
       ip IP-ADDRESS
	sni {
		domain_cert etc/manager.crt
		domain_key etc/manager.key
		domains IP-ADDRESS
	}
	rewrite
#	allow_origin https://IP-ADDRESS:1500/ispmgr
}
listen {
	ip IP-ADDRESS_1
	port 1500
	redirect
}
```

--------------------------------

### phpextensions.install

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-api

Installs a PHP extension.

```APIDOC
## phpextensions.install

### Description
Installs one or more PHP extensions.

### Parameters
- **elid** (string) - Required - Comma-delimited list of extension names to install.
```

--------------------------------

### Install and configure extension via PECL

Source: https://www.ispmanager.com/docs/ispmanager/install-a-php-extension-manually

Commands to install an extension using the PECL binary and register it in the PHP configuration directory.

```bash
/opt/<PHP version directory>/bin/pecl install <extension name>
```

```bash
echo extension=<extension name> >> /opt/<PHP version directory>/etc/php.d/<extension name>.ini
```

```bash
echo extension=memcache.so >> /opt/<PHP version directory>/etc/php.d/<extension name>.ini
```

--------------------------------

### Install ISPmanager with custom flags

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Installs the latest stable version while ignoring hostname errors and skipping Let's Encrypt certificate issuance.

```bash
sh install.eu.sh --ignore-hostname --no-letsencrypt --release stable ispmanager-lite
```

--------------------------------

### Start the Django development server

Source: https://www.ispmanager.com/docs/ispmanager/how-to-install-django

Commands to start the Django development server using manage.py on a specific port or IP address.

```bash
python project_name/manage.py runserver 8000
```

```bash
python project_name/manage.py runserver 127.0.0.1:8000
```

--------------------------------

### Dashboard XML Configuration Example

Source: https://www.ispmanager.com/docs/developer-guide/dashboard-description

This example demonstrates the structure of the dashboard XML, including block definitions, tool buttons, columns, and localized messages.

```xml
<?xml version="1.0"?>
<doc lang="ru" func="dashboard" binary="/ispmgr" host="https://localhost:4200" themename="dragon" stylesheet="dashboard" features="3a604f5c3c6d5683f90a1f63f1d171aa0" notify="0" favorite="no" pin="no">
  <block name="license.mgr.info" position="right" type="isplicense" func="license.mgr.info" display="" prev=""/>
  <block name="capacity" position="right" type="list" func="server_capacity" enable_autoupdate="yes" prev="" display=""/>
  <block name="session" position="right" type="list" func="session" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="session" type="list"/>
    <toolbtn name="kill"/>
    <col name="name" sort="alpha" sorted="+1"/>
    <col name="level"/>
    <col name="ip"/>
    <col name="idle"/>
  </block>
  <block name="longtask" position="right" type="list" func="longtask" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="longtask" type="list"/>
    <toolbtn name="view" default="yes"/>
    <toolbtn name="delete"/>
    <col name="realname" type="data" sort="alpha"/>
    <col name="startdate" type="data" sort="alpha" sorted="-1"/>
    <col name="enddate" type="data" sort="alpha"/>
    <col name="state" sort="prop"/>
  </block>
  <block name="authlog" position="right" type="list" func="authlog" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="authlog" type="list"/>
    <col name="time" sort="alpha" sorted="-1"/>
    <col name="user" sort="alpha" sorted="+2"/>
    <col name="ip" sort="alpha"/>
  </block>
  <block name="taskbar" position="left" type="toolbar" display="" prev=""/>
  <block name="sysinfo" position="left" type="list" func="dashboard.sysinfo" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="sysinfo" type="list"/>
  </block>
  <block name="software_info" position="left" type="software" func="dashboard.software" prev="" display="">
    <toolbtn name="gotodetails" func="feature" type="list"/>
  </block>
  <block name="changelog.changes" position="left" type="changelog" func="changelog.changes" rows="5" prev="" display="">
    <toolbtn name="gotodetails" func="changelog" type="list"/>
    <col name="desc" sorted="+1"/>
    <col name="type"/>
  </block>
  <block name="new_features" position="top" type="url" display="" prev="">
    <url>https://www.ispmanager.ru/sites/all/themes/custom/ispmanagertheme/ispmanageradv/ru6/?mgrurl=https://localhost:4200/ispmgr</url>
  </block>
  <messages name="dashboard" checked="3a604f5c3c6d5683f90a1f63f1d171aa">
    <msg name="actioncolumn">Action</msg>
    <msg name="taskbar_admin">Panel administrator</msg>
    <msg name="taskbar_help">Help</msg>
    <msg name="taskbar_usrparam">User settings</msg>
    <msg name="title">Dashboard</msg>
    <msg name="title_changelog.changes">Changelog 6.84.0</msg>
    <msg name="title_usageinfo">Time usage</msg>
    <msg name="title_taskbar">Taskbar</msg>
    <msg name="hint_reload">Update data</msg>
    <msg name="tip_dashboard_top">You can add a panel administrator and log in to it in one click (most administration tasks are performed with admin privileges)</msg>
    <msg name="title_new_features">New features</msg>
    <msg name="taskbar_adduser">Create user</msg>
    <msg name="taskbar_addwebdomain">Create site</msg>
    <msg name="taskbar_addemail">Create mailbox</msg>
    <msg name="taskbar_adddomain">Create domain</msg>
    <msg name="taskbar_shellclient">Launch Shell client</msg>
    <msg name="taskbar_addsorter">Set email filter</msg>
    <msg name="taskbar_responder_settings">Configure autoresponder</msg>
    <msg name="taskbar_phpmyadmin">Open phpMyAdmin</msg>
    <msg name="taskbar_phppgadmin">Open phpPgAdmin</msg>
    <msg name="taskbar_roundcube">Open webmail client</msg>
    <msg name="taskbar_adddatabase">Creare database</msg>
    <msg name="taskbar_addemaildomain">Create mail domain</msg>
    <msg name="taskbar_adddocker">Create Docker container</msg>
    <msg name="taskbar_addcron">Create a Cron job</msg>
    <msg name="taskbar_addbackup">Crate backup</msg>
    <msg name="taskbar_addftp_user">Create FTP user</msg>
    <msg name="taskbar_execute">Execute command</msg>
    <msg name="taskbar_restart">Reboot server</msg>
    <msg name="taskbar_update">Update the panel</msg>
    <msg name="title_license.mgr.info">About ispmanager Trial</msg>
    <msg name="title_capacity">Server resources</msg>
    <msg name="title_session">Active sessions</msg>
    <msg name="title_longtask">Background tasks</msg>
    <msg name="title_authlog">Access log</msg>
    <msg name="title_sysinfo">System information</msg>
    <msg name="title_software_info">Server software</msg>
  </messages>
</doc>
```

--------------------------------

### License renewal request

Source: https://www.ispmanager.com/docs/for-partners/reselling-ispmanager-licenses-via-api

Example of a GET request to trigger a license renewal in the partner billing system.

```http
https://api.PARTNER_BILLING.com/?action=prolong&query=startform%3Dservice.prolong%26utm_source%3Dispmanager_panel%26elid%3D8898549%26utm%5Fsource%3Dispmanager%5Fpanel&license=8898549&ip=37%2E230%2E114%2E96&utm_source=ispmanager_panel
```

--------------------------------

### Create the plugin configuration file

Source: https://www.ispmanager.com/docs/developer-guide/plug-in-example-how-to-add-a-menu-item

Initialize the XML configuration file for the plugin.

```bash
touch myaddon.xml
```

--------------------------------

### Example composer.json configuration file

Source: https://www.ispmanager.com/docs/ispmanager/php-composer-module

A sample configuration file defining project metadata and dependency requirements.

```json
{
    "require": {
            "monolog/monolog": ">=1.0.2 <2.1.2"
    },
    "description": "This example",
    "keywords": ["testing", "example"],
    "type": "project",
    "version": "1.0.0",
    "homepage": "https://example.com",
    "readme": "readme.md",
    "license": "MIT",
    "authors": [{
            "name": "User",
            "email": "user@example.com",
            "homepage": "https://www.example.com",
            "role": "Developer"
    }],
    "support": {
            "email": "support@example.org"
    }
}
```

--------------------------------

### Install extension from source code

Source: https://www.ispmanager.com/docs/ispmanager/install-a-php-extension-manually

Steps to download, compile, and enable a PHP extension from source code.

```bash
cd /tmp
wget -O env.tar.gz http://pecl.php.net/get/env
tar xzvf env.tar.gz
cd env-0.2.1/
```

```bash
/opt/<version directory PHP>/bin/phpize
./configure --with-php-config=/opt/<PHP version directory>/bin/php-config && make && make install
```

```bash
echo 'extension=env.so' > /opt/<PHP version directory>/etc/php.d/20-env.ini
```

--------------------------------

### License plan change request

Source: https://www.ispmanager.com/docs/for-partners/reselling-ispmanager-licenses-via-api

Example of a GET request to change the license plan in the partner billing system.

```http
https://api.PARTNER_BILLING.com/?action=changepricelist&query=startform%3Dservice%2Echangepricelist%2Egetmoney%26pricelist%3D55231%26elid%3D8898549%26utm%5Fsource%3Dispmanager%5Fpanel&license=8898549&ip=37%2E230%2E114%2E96&utm_source=ispmanager_panel&pricelist=IM6L
```

--------------------------------

### Define module configuration in XML

Source: https://www.ispmanager.com/docs/developer-guide/add-module

Create an exampleplugin.xml file to register the module with the panel. Ensure the file is placed in the correct plugin directory.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
  <plugin name="exampleplugin">
   	<dist>1</dist>
	<weight>1</weight>
   	<pricelist>12345</pricelist>
   	<license>ExampleLicense</license>
<free/>
	<settings>exampleplugin.settings</settings>
	<msg name="desc_short" lang="ru">Модуль Example</msg>
	<msg name="desc_short" lang="en">Module Example</msg>
	<msg name="desc_full" lang="ru">Пример добавления модуля в ispmanager</msg>
	<msg name="desc_full" lang="en">Example of adding custom module to ispmanager</msg>
	<msg name="msg_help_links" dist="1" lang="ru">&lt;a href="http://example.com" target="_blank"&gt;Описание ссылки для версий Lite, Pro, Host&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="3" lang="ru">&lt;a href="https://rudocs.ispmanager.com/ispmanager-business/integratsiya-c-viruslive" target="_blank"&gt;Описание ссылки для версии Business&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="1" lang="en">&lt;a href="http://example.com" target="_blank"&gt;Link description for Lite, Pro, Host versions&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="3" lang="en">&lt;a href="http://example.com" target="_blank"&gt;Link description for Business version&lt;/a&gt;</msg>
  </plugin>
</mgrdata>
```

--------------------------------

### Install GateKeeper Package

Source: https://www.ispmanager.com/docs/ispmanager/blackwall-gatekeeper-botguard

Updates the package list and installs the GateKeeper software.

```bash
apt update
```

```bash
apt install botguard-gatekeeper
```

--------------------------------

### Create the XML configuration file

Source: https://www.ispmanager.com/docs/developer-guide/plug-in-example-how-to-add-a-menu-item

Use the touch command to create the required XML file in the system directory with appropriate permissions.

```bash
touch /usr/local/mgr5/etc/xml/ispmgr_mod_menu.xml
```

--------------------------------

### Nginx ssl_servers_inc.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example configuration for including certificate-specific server files in Nginx.

```nginx
include /etc/nginx/ssl_cert_servers/*.conf;
```

--------------------------------

### Implement plugin handler script

Source: https://www.ispmanager.com/docs/developer-guide/report-plugin-example

Create this script at /usr/local/mgr5/addon/report_example.sh with 750 permissions to generate the report data and XML structure.

```bash
#!/bin/bash

# notice the value that came from the form from <select name=“period” /> and
# if the “Previous month” option was selected, one set of strings will be written to the variable reportdata,
# in other cases (including default options before selection in the form) - else
period=$PARAM_period
if [[ "$period" == "previousmonth" ]]
then
read -r -d '' reportdata <<-EOM
    <elem><value1>7.0</value1><value2>13.0</value2><date>2024-10-29</date></elem>
    <elem><value1>10.0</value1><value2>26.0</value2><date>2024-10-30</date></elem>
    <elem><value1>12.0</value1><value2>11.0</value2><date>2024-10-31</date></elem>
EOM
else
read -r -d '' reportdata <<-EOM
    <elem><value1>10.0</value1><value2>24.0</value2><date>2024-11-01</date></elem>
    <elem><value1>12.0</value1><value2>18.0</value2><date>2024-11-02</date></elem>
    <elem><value1>8.0</value1><value2>20.0</value2><date>2024-11-03</date></elem>
EOM
fi

# output an XML for the page with a set of lines above incorporated in it
cat << EOM
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="ru" func="report.example">
    <metadata type="report">
        
        <!-- form metadata for period selection at the top of the report -->
        <form>
            <field name="period">
                <select name="period" />
            </field>
            <buttons>
                <button type="ok" action="report.example" name="ok"/>
            </buttons>
        </form>
        
        <!-- Page title -->
        <text name="title" />
        
        <!-- Report description: one table withe three columns and a diagram based on the table -->
        <band name="values" psort="date">
            <col name="date" type="data" sort="alpha" />
            <col name="value1" type="data" sort="digit" />
            <col name="value2" type="data" sort="digit" />
            <diagram name="values" label="date" type="line" >
                <line data="value1" />
                <line data="value2" />
            </diagram>
        </band>
    </metadata>
    
    <!-- report data, insert the generated set of <elem> lines here-->
    <reportdata>
        <values>
            ${reportdata}
        </values>
    </reportdata>
    
    <!-- Localization messages -->
    <messages>
        <msg name="title">Report example</msg>
        <msg name="values">Series of values</msg>
        <msg name="value1">Parameter 1</msg>
        <msg name="value2">Parameter 2</msg>
        <msg name="date">Date</msg>
        <msg name="period">Period</msg>
        <msg name="msg_ok">Show the report</msg>
        <msg name="msg_hidedata">Hide data</msg>
        <msg name="msg_nodata">No data</msg>
        <msg name="msg_showdata">Show data</msg>
    </messages>
    
    <!-- values for period selection form -->
    <slist name="period">
        <val msg="yes" key="currentmonth">Current month</val>
        <val msg="yes" key="previousmonth">Previous month</val>
    </slist>
    
    <!-- value of the selected period to be displayed in the selection form after data submission-->
    <period>${period}</period>
</doc>
EOM
```

--------------------------------

### services.resume

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-api

Start the selected service.

```APIDOC
## services.resume

### Description
Starts the selected service.

### Parameters
- **elid** (string) - Required - One or more object's unique identifiers comma-delimited with space.
```

--------------------------------

### Install unzip utility

Source: https://www.ispmanager.com/docs/for-partners/reselling-ispmanager-modules-through-whmcs

Install the unzip utility for Debian-based or RHEL-based operating systems.

```bash
apt install unzip
```

```bash
yum install unzip
```

--------------------------------

### Install wget utility

Source: https://www.ispmanager.com/docs/for-partners/reselling-ispmanager-modules-through-whmcs

Install the wget utility for Debian-based or RHEL-based operating systems.

```bash
apt install wget
```

```bash
yum install wget
```

--------------------------------

### Using Monolog dependency

Source: https://www.ispmanager.com/docs/ispmanager/php-composer-module

Example of initializing and using the Monolog library after including the autoloader.

```php
<?php
require_once('vendor/autoload.php');
use Monolog\Level;
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
$logger = new Logger('channel-name');
$logger->pushHandler(new StreamHandler('app.log', Logger::DEBUG));
$logger->info('This is log');
$logger->warning('This is log warning');
$logger->error('This is log error');
?>
```

--------------------------------

### Initialize quota files

Source: https://www.ispmanager.com/docs/ispmanager/set-disk-quotas

Create necessary quota files on the root partition.

```bash
quotacheck -gum /
```

--------------------------------

### Nginx manager.conf example

Source: https://www.ispmanager.com/docs/ispmanager/ssl-for-external-applications

Example server block configuration for managing SSL certificates in Nginx.

```nginx
server {
        server_name localhost;
        disable_symlinks if_not_owner;
        include /etc/nginx/vhosts-includes/*.conf;
        add_header Strict-Transport-Security "max-age=31536000;";
        listen 1501 ssl;
        listen 172.31.97.76:1501 ssl default_server;
        ssl_certificate "/usr/local/mgr5/etc/manager.crt";
        ssl_certificate_key "/usr/local/mgr5/etc/manager.key";
        ssl_ciphers EECDH:+AES256:-3DES:RSA+AES:!NULL:!RC4;
        ssl_prefer_server_ciphers on;
        ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
}
```

--------------------------------

### Configure and initialize Django project

Source: https://www.ispmanager.com/docs/ispmanager/how-to-install-django

Commands to activate the virtual environment, upgrade pip, install dependencies, and initialize a new Django project.

```bash
source .venv/bin/activate
```

```bash
pip install --upgrade pip
```

```bash
pip install wheel
```

```bash
pip install mysqlclient
```

```bash
pip install mysqlclient==2.1.0
```

```bash
django-admin startproject project_name
```

--------------------------------

### DKIM record format example

Source: https://www.ispmanager.com/docs/ispmanager/create-a-mail-domain

Example of a DKIM TXT record format for a mail domain.

```text
dkim._domainkey.example.com
```

--------------------------------

### Install ISPmanager with OpenLiteSpeed

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-installation-guide

Installs the latest stable version configured with the OpenLiteSpeed web server.

```bash
sh install.eu.sh --openlitespeed --release stable ispmanager-lite
```

--------------------------------

### phpinstall.install

Source: https://www.ispmanager.com/docs/ispmanager/ispmanager-api

Installs the selected PHP version.

```APIDOC
## phpinstall.install

### Description
Installs the selected PHP version based on the provided unique identifier.

### Parameters
- **elid** (string) - Required - One or more object's unique identifiers comma-delimited with space.
```

--------------------------------

### Example of updated phpMyAdmin URL

Source: https://www.ispmanager.com/docs/ispmanager/configuring-links-to-email-client-phpmyadmin-phppg

An example of a resulting URL after updating the path configuration in the control panel.

```text
http://172.31.97.45/example/phpmyadmin
```

--------------------------------

### XML example for object parameters

Source: https://www.ispmanager.com/docs/coremanager/guide-to-ispsystem-software-api

A concrete example of an XML response detailing properties of a specific object.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<doc>
	<elid>example.com</elid>
	<name>example.com</name>
	<gid>1001</gid>
	<alias>www.example.com test.example.com</alias>
	<cgi/>
	<phptype>phpcgi</phptype>
	<ssi/>
	<frp/>
	<sslport>443</sslport>
	<alluser>50</alluser>
	<shelluser>5</shelluser>
	<domain>1</domain>
	<base>3</base>
	<traf>4096</traf>
	<disklimit>50</disklimit>
</doc>
```

--------------------------------

### Composer installation dry-run command

Source: https://www.ispmanager.com/docs/ispmanager/php-composer-module

The command executed by ISPmanager to emulate package installation and validate the configuration.

```bash
/bin/sh -c cd\ /var/www/cm/data/www/example.com\;./composer.phar\ install\ --dry-run
```
Tokens:
Raw