MachPanel Knowledgebase » Downloads » Manuals and Guides

WebHelp/Manual for ADSync v6

mudesira.munir — Mon, 04 Dec 2023 11:48:24 GMT

Summary

It is an ADSync Web Help which provides information on how to Install and Configure ADsync.

Applies To

This article applies to MachPanel Build v7 and ADSync v6.

ADSync Manual

For online viewing click on this link. View the ADSync Web Help.
Please download ADSync Help files in PDF & CHM format:

ADSYNC Installation Guide.pdf
ADSync Installation Guide.chm
- If CHM files are blocked do following:
1. Windows 10: Run Windows Explorer, right-click on the CHM file, and select Properties from the popup menu. Click on the Unblock button immediately below the Advanced button on the General page. Click Apply to show the content. Once the CHM file has been unblocked, the Unblock button disappears.
2. Mac: Download CHM reader and open CHM files.

SOP for preparation of Centos (Linux) & Ubuntu Sealed Images for Hyper-V

mudesira.munir — Wed, 15 Jul 2020 05:26:33 GMT

Summary

This article provides information about preparation of sealed images for Centos (Linux) and Ubuntu Virtual Machines.

Applies To

Applies to MachPanel v7.2.x and onward.

Important Note:

It is recommended to Create Virtual Machines for preparing sealed image based on Gen2 and in MachPanel also choose the option for Generation 2.
You may download Preconfigured Gen 2 sealed images to use with MachPanel for Centos7 and Ubuntu20 from links below:
- Centos7.vhdx
- Ubuntu20.vhdx
- Ubuntu20CLI.vhdx
- Ubuntu22.vhdx
- Ubuntu22CLI.vhdx
- Ubuntu24.vhdx
- Ubuntu24CLI.vhdx

Make sure when adding sealed image details to MachPanel for Ubuntu22, set correct "Default User" i.e. "machsol" (without quotes) if our preconfigured sealed image is used.
While preparing the sealed image, ensure that rc.local (attached) contains the contents. Also mentioned at the end of this KB. For Ubuntu VMs with kernel version 6.11 or above, the NoCloud ISO option must be selected.
Note: This approach will work for all supported Ubuntu versions, provided the VM is sealed using the attached rc.local.
On the Hyper-V host, ensure that the required ADK is installed.
https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install

Pre-requisites

While installing CentOS, for Partitioning either choose Automatically Configure Partitioning OR if you choose I will configure partitioning set the Volume Group Name as centos.
Create a standard Centos & build
Configure the Network - nmtui
Install dos2unix - sudo yum install dos2unix
Change Permissions for rc.local file to run on bootup - chmod +x /etc/rc.d/rc.local
Remove all files from /etc/netplan/ folder (In case of Ubunto only)

Procedure for preparing Centos (Linux) Sealed Image for Gen 2 virtual Machines

Make rc.local file settings like below in your sealed image. (sudo nano /etc/rd.d/rc.local)

================================================================================

#!/bin/bash
touch /var/lock/subsys/local
sed -n 's/;#COMMAND//p' /root/Config.bat > /root/Config.bak && mv -f /root/Config.bak /root/Config.bat && chmod 777 /root/Config.bat && dos2unix /root/Config.bat
sh /root/Config.bat
rm -f /root/Config.bat
rm -f /root/Config.bak

================================================================================

Selinux Config: Selinux Config file should contain below settings. (root\etc\SELINUX\Config)

================================================================================

Procedure for preparing Centos (Linux) Sealed Image for Gen1 virtual Machines

Below are the settings which are required for preparing the Linux (Centos) Sealed image for Gen1.

Make sure your Centos flavor supports floppy

Create Floppy Folder under /media - mkdir /media/floppy

Make rc.local file settings like below in your sealed image. (sudo nano /etc/rc.local)

================================================================================

#!/bin/sh
#
# This script will be executed *after* all the other init scripts.
# You can put your own initialization stuff in here if you don't
# want to do full Sys V style init stuff.

touch /var/lock/subsys/local
insmod /lib/modules/$(uname -r)/kernel/drivers/block/floppy.ko
mount /dev/fd0 /media/floppy && mount -o remount,rw /dev/fd0
wait
sed -n 's/;#COMMAND//p' /media/floppy/Config.bat > /media/floppy/Config.bak && mv -f /media/floppy/Config.bak /media/floppy/Config.bat && chmod 777 /media/floppy/Config.bat && dos2unix /media/floppy/Config.bat
sh /media/floppy/Config.bat
rm -f /media/floppy/Config.bat
rm -f /media/floppy/Config.bak
umount -l /dev/fd0

================================================================================

Selinux Config: Selinux Config file should contain below settings. (root\etc\SELINUX\Config)

Procedure for preparing Ubuntu Sealed Image

Important Note: While preparing sealed image below 2 commands need to run in Ubuntu terminal. Make sure internet is active before executing these commands:

Sudo apt-get update
Sudo apt-get install linux-azure

For Ubuntu Flavors / Versions with no rc.local file, following should be taken care during sealed image preparation.

Create rc.local file

=========================================================================

nano /etc/rc.local
Add following Content to rc.local file

#!/bin/sh -e
#
# rc.local
#
# This script is executed at the end of each multiuser runlevel.
# Make sure that the script will "exit 0" on success or any other
# value on error.
#
# In order to enable or disable this script just change the execution
# bits.
#
# By default this script does nothing.
touch /var/lock/subsys/local
#sed -n 's/;#COMMAND//p' /root/Config.bat > /root/Config.bak && mv -f /root/Config.bak /root/Config.bat && chmod 777 /root/Config.bat && dos2unix /root/Config.bat
sh /root/Config.bat
rm -f /root/Config.bat
#rm -f /root/Config.bak
exit 0
chmod +x /etc/rc.local

===============================================================================

Create rc-local.service Service

========================================================================

sudo nano /etc/systemd/system/rc-local.service
Then add the following content to it
[Unit]
Description=/etc/rc.local Compatibility
ConditionPathExists=/etc/rc.local

[Service]
Type=forking
ExecStart=/etc/rc.local start
TimeoutSec=0
StandardOutput=tty
RemainAfterExit=yes
SysVStartPriority=99

[Install]
WantedBy=multi-user.target

sudo chmod +x /etc/rc.local
printf '%s\n' '#!/bin/bash' 'exit 0' | sudo tee -a /etc/rc.local

sudo chmod +x /etc/rc.local
sudo systemctl enable rc-local
sudo systemctl start rc-local.service
sudo systemctl status rc-local.service

===============================================================================

Ubunto 22/24.04 RC file:

===============================================================================

#!/bin/sh -e
touch /var/lock/subsys/local

# Define paths
CONFIG_SRC="/mnt/cdrom/Config.bat"
CONFIG_DST="/root/Config.bat"
NETPLAN_SRC="/mnt/cdrom/01-NetworkSettings.yaml"
NETPLAN_DST="/etc/netplan/01-NetworkSettings.yaml"
CONFIG_HASH="/root/.config_hash"
NETPLAN_HASH="/root/.netplan_hash"

# Mount ISO
mkdir -p /mnt/cdrom
mount /dev/cdrom /mnt/cdrom 2>/dev/null || true

# === Handle Config.bat ===
if [ -f "$CONFIG_SRC" ]; then
NEW_HASH=$(sha256sum "$CONFIG_SRC" | awk '{print $1}')
OLD_HASH=""
[ -f "$CONFIG_HASH" ] && OLD_HASH=$(cat "$CONFIG_HASH")

if [ "$NEW_HASH" != "$OLD_HASH" ]; then
echo "Detected new or updated Config.bat, executing..."

cp "$CONFIG_SRC" "$CONFIG_DST"
sed -n 's/;#COMMAND//p' "$CONFIG_DST" > /root/Config.bak && mv -f /root/Config.bak "$CONFIG_DST"
chmod 777 "$CONFIG_DST"
dos2unix "$CONFIG_DST"

sh "$CONFIG_DST"
rm -f "$CONFIG_DST"

echo "$NEW_HASH" > "$CONFIG_HASH"
echo "$(date): Config.bat updated and executed" >> /var/log/config.log
else
echo "$(date): Config.bat unchanged, skipping execution" >> /var/log/config.log
fi
else
echo "$(date): Config.bat not found on ISO" >> /var/log/config.log
fi

# === Handle Netplan config ===
if [ -f "$NETPLAN_SRC" ]; then
NEW_HASH=$(sha256sum "$NETPLAN_SRC" | awk '{print $1}')
OLD_HASH=""
[ -f "$NETPLAN_HASH" ] && OLD_HASH=$(cat "$NETPLAN_HASH")

if [ "$NEW_HASH" != "$OLD_HASH" ]; then
echo "Detected updated Netplan configuration, applying..."

cp "$NETPLAN_SRC" "$NETPLAN_DST"
chmod 600 "$NETPLAN_DST"
netplan apply

echo "$NEW_HASH" > "$NETPLAN_HASH"
echo "$(date): Netplan updated and applied" >> /var/log/config.log
else
echo "$(date): Netplan unchanged, skipping apply" >> /var/log/config.log
fi
else
echo "$(date): Netplan not found on ISO" >> /var/log/config.log
fi

# Cleanup
umount /mnt/cdrom 2>/dev/null || true
eject /dev/cdrom 2>/dev/null || echo "$(date): Failed to eject CD-ROM" >> /var/log/config.log
exit 0

========================================================================

Developers Manual for Integrating MachPanel API - SOAP API

mudesira.munir — Thu, 06 Nov 2014 00:17:17 GMT

Important Note: There are two types of API available SOAP and REST. REST API is easy to use and user can try operations on Swagger interface. It is recommended is to use REST API .

SOAP API will exist but not recommended to use.

REST API: https://kb.machsol.com/Knowledgebase/55650/MachPanel-REST-API-Configuration

Download Information

MachPanel API is basically a web service which uses SOAP messages to communicate with the Control Server and client application. Please download Developers Manual for Integrating MachPanel API.pdf from Attachment\Download section in order to review MachPanel API details.

Please also download PHP examples for MachPanel API from Attachment\Download section.

The zip file includes the following examples for API:

Cancel or Delete Customer.php
Create Customer.php
Create Reseller.php
reset customer password.php
Subscribe Multiple.php
SubscribeExchangeHosting.php
SubscribeLyncHosting.php
Update Customer.php
Update Reseller.php
MachPanelClientHandler.php

Applies To

MachPanel v6 and above

WHMCS Integration and configuration with MachPanel-v7

mudesira.munir — Tue, 16 Sep 2014 00:12:17 GMT

Summary

This article provides information on how to configure/integrate WHMCS with MachPanel.

Applies

This article is for latest WHMCS integration package updated 1st June 2023 and is compatible with MachPanel v7.2.11 and Later. The integration is tested using WHMCS 8.1.0 and is supposed to work in Newer versions of WHMCS also.

Important Notes

File structure of WHMCS integration has changed.
Please remove previous folder called "mp_utilities" from WHMCS installation directory.
You must only have one folder as "<WHMCS ROOT>\modules\servers\machpanel" and inside this folder all files for MachPanel Integration will exist.
Integration details are included in the "WHMCS Integration.docx" file under the zip package.

MachPanel Integration with WHMCS

In this document we will study and define the pre-requisites, functionalities and configurations to integrate MachPanel Hosting Control system with WHMCS billing management system.

Functionalities

Following is a complete list of functions that MachPanel WHMCS integration handles.

Customer Management:
1. Create Customer.
2. Edit Customer.
3. Change Password.
4. Delete Customer.
5. Manage Customer link.
Contact Management:
1. Create Contact.
2. Update Contact.
3. Change Password.
4. Delete Contact.
Reseller Customer Management:
1. Create Reseller.
2. Edit Reseller.
3. Change Password.
4. Delete Reseller.
5. Manage Reseller link.
Exchange Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
SharePoint Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
CRM Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
SFB/Lync Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Shared/Web Hosting Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Hyper-V Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Shared/Web Hosting
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Microsoft Office 365 CSP Module:
1. Ordering/provisioning, cancellation, link to manage subscription.
2. Suspend and Resume of individual offer(s) within the CSP Subscription
3. Ordering/provisioning, cancellation of Managed AddOn.
MimeCast Product:
1. Ordering/provisioning, cancellation
2. Quantity update for individual sub products of MimeCast
RDS Hosting Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Work Folders Hosting Module:
1. Ordering/provisioning, suspend, resume, cancellation, link to manage subscription.
2. Ordering/provisioning, cancellation of Managed AddOn.
Secure Login to control panel via links provided in WHMCS interfaces.
1. Admin
2. Client

Product/Service(s) Configuration

For WHMCS to work with MachPanel provisioning engine, service provider is required to perform some required configurations. These configurations are required on both MachPanel and WHMCS ends. Please view complete instructions in WHMCS Integration guide from within the zip file in download section:

Note to Prohibit MachPanel Customer auto create on WHMCS client add.

You are allowed to auto create a customer in MachPanel when it is created in WHMCS, or create it only when the customer subscribes for a service.

Locate following line in hooks.php or mp_hooks.php :

add_hook("ClientAdd",1,"hook_ClientAdd");

and update it as below:

//add_hook("ClientAdd",1,"hook_ClientAdd");

Contents of .Zip File

machpanel (folder)
- configuration.php
- hooks.php
- machpanel.php
- MachPanelClientHandler.php
- ProxyClasses.php
currency list.txt
locale list.txt
mp_hooks.php
templates list.txt
WHMCS Integration.docx (Use this file to move ahead with integration)

MachPanel v7.3.60 - Customer Administrator Manual

mudesira.munir — Wed, 29 Jan 2014 21:17:12 GMT

Summary

Provides overview information about MachPanel features and application tools to manage and use MachPanel.

Applies To

This article applies to MachPanel Build v7.3.60 and below.

Customer Manual

For online viewing click on this link. View the Customer manual here.
Please download Customer Help files in PDF & CHM format from attachment/download section below.
- If CHM files are blocked do following:
1. Windows 10: Run Windows Explorer, right-click on the CHM file, and select Properties from the popup menu. Click on the Unblock button immediately below the Advanced button on the General page. Click Apply to show the content. Once the CHM file has been unblocked, the Unblock button disappears.
2. Mac: Download CHM reader and open CHM files.

MachPanel v7.3.60 - Reseller Administrator Manual

mudesira.munir — Wed, 29 Jan 2014 21:06:26 GMT

Summary

Provides overview information about MachPanel features and application tools to manage and use MachPanel.

Applies To

This article applies to MachPanel Build 7.3.60 and above.

Reseller Manual

For online viewing click on this link. View the Reseller manual here.
Please download Reseller Help files in PDF & CHM format from attachment/download section below.
- If CHM files are blocked do following:
1. Windows 10: Run Windows Explorer, right-click on the CHM file, and select Properties from the popup menu. Click on the Unblock button immediately below the Advanced button on the General page. Click Apply to show the content. Once the CHM file has been unblocked, the Unblock button disappears.
2. Mac: Download CHM reader and open CHM files.

MachPanel v7.3.60 - Provider Administrator Manual

mudesira.munir — Wed, 29 Jan 2014 20:57:48 GMT

Summary

Provides overview information about MachPanel features and application tools to manage and use MachPanel.

Applies To

This article applies to MachPanel Build v7.3.60.

Provider Manual

For online viewing click on this link. View the Provider manual here.
Please download Provider Help files in PDF & CHM format from attachment/download section below.
- If CHM files are blocked do following:
1. Windows 10: Run Windows Explorer, right-click on the CHM file, and select Properties from the popup menu. Click on the Unblock button immediately below the Advanced button on the General page. Click Apply to show the content. Once the CHM file has been unblocked, the Unblock button disappears.
2. Mac: Download CHM reader and open CHM files.

MachPanel v.4 Hostmatic Extension Kick Start Guide

zohaib.shaikh — Wed, 25 Feb 2009 14:34:14 GMT

Download Information

Provides step by step instructions, in chronological order to get started with the MachPanel's Hostmatic v.4.

Applies To

MachPanel Hostmatic v.4

MachPanel Configuration Studio Guide

mudesira.munir — Wed, 17 Dec 2008 00:22:33 GMT

Download Information

This guide is an illustration showing how to use MachPanel Configuration Studio utility. It will help you carry out initial setup and essential configuration settings as required. Please carefully follow this guide to understand the benefits and usage of Configuration Studio.

Applies To

MachPanel Provisioning System v.7

MachPanel v.7 Storefront Integration With Provider Website

zohaib.shaikh — Tue, 04 Nov 2008 02:16:43 GMT

Download Information

This is a detailed step-by-step guide explaining the MachPanel Storefront integration with your (Provider’s) website. This integration will allow your clients to have one control panel login once they have ordered products. Furthermore, this guide also illustrates how to customize the look and feel of the order form according to Provider’s taste and need.

Applies To

MachPanel v.7

Download

GUIDE: MachPanel Storefront integration with Provider's website.