If you have a custom panel and would like to integrate Softaculous, you have made the right decision and you are at the right place.<\/p>\n\n\n\n
The pricing for custom based integrations is $0.1\/month\/user with minimum $100\/month in billing.<\/p>\n\n\n\n
Please access the following link : Note<\/strong> : This will download the custom package which will be in the name of the VERSION.zip E.g. If the version is 4.0.3 it will download the 4.0.3.zip In this documentation we refer this package as custom.zip custom.zip is the Softaculous core. Please unzip and store the files in a suitable location on the server. e.g.<\/p>\n\n\n\n NOTE :<\/strong> Softaculous has to be installed on the server(s) where the user files will be stored. It cannot install on ANY REMOTE server. Softaculous should be able to access the users directories to be able to unzip and delete files when required. If you have multiple servers then you will have to install Softaculous on all the servers. The PANELs webserver (e.g. Apache) must point to the enduser<\/strong> folder which is there in the Softaculous Core. integrating.zip has 2 important files : NOTE : <\/strong>universal.php must be placed in the enduser folder. e.g. \/usr\/local\/softaculous\/enduser\/universal.php<\/p>\n\n\n\n NOTE : <\/strong>softpanel.php must be placed in the includes folder. e.g. \/usr\/local\/softaculous\/includes71\/softpanel.php universal.php is a very important configuration file of Softaculous. It contains the variables, that are required by Softaculous to work. It has the Path Definitions of Softaculous Files and also most of the Configuration of Softaculous is stored in this file. Below is a sample configuration file. But while integrating PLEASE use the universal.php from the custom.zip you downloaded in the 1st step. The files in integrating.zip are just for example.<\/p>\n\n\n\n $globals[‘path’]<\/strong> – Is the Path where Softaculous CORE will reside This is the Main file which will act as the point of interacting with your Control Panel. Its a simple class which takes care of many important activities like Creating and Deleting Databases, the disk space available, the logged in user information, etc. Here is a little bit explanation of important functions. There are enough comments in the code you downloaded.<\/p>\n\n\n\n This is the Contructor class. $this->domainroots<\/strong> – An array of the domains and their PATHS. See function domainroots()<\/strong> $this->spaceremain<\/strong> – An integer of the space available. See function spaceremain()<\/strong><\/p>\n\n\n\n This is just a function to load any data which might be used by other functions in the class when they are called. You can put all your important data processing code here so that you dont have to reload everything again.<\/p>\n\n\n\n You must return the array as shown in the code. It is self explanatory. $user[‘softdir’]<\/strong> is the path where the .softaculous<\/strong> folder is created.<\/p>\n\n\n\n Return value should be a array as shown above. It is of the format domain => \/path\/to\/files\/of\/domain<\/p>\n\n\n\n Return value should be the MySQL host.<\/p>\n\n\n\n Return value should be the max number of DBs allowed to this user. If a string is given it will be assumed as Unlimited!<\/p>\n\n\n\n This function is called to CHECK whether the existing number of databases is not GREATER that or EQUAL to (>=) then the allowed number of Databases. Return value should be an int or a string.<\/p>\n\n\n\n If the panel requires to modify the DB NAME that is to be created when installing a script, it has to be done here. Many panels e.g. cPanel accept input from users as DBNAME<\/strong> but create Databases like USERNAME_DBNAME<\/strong>. In such a case this function must return USERNAME_DBNAME<\/strong><\/p>\n\n\n\n If the panel requires to modify the Database USER NAME that is to be created when installing a script, it has to be done here. Many panels e.g. cPanel accept input from users as DBUSERNAME<\/strong> but create Databases like USERNAME_DBUSERNAME<\/strong>. In such a case this function must return USERNAME_DBUSERNAME<\/strong><\/p>\n\n\n\n This is a function to check whether the Database already exists or not Should return TRUE or FALSE as the case may be.<\/p>\n\n\n\n This is a function to check whether the Database USER already exists or not Should return TRUE or FALSE as the case may be.<\/p>\n\n\n\n This function should create the DATABASE and also the Database USER. The user must also be added to the database so that the user can conduct all necessary operations on the Database. This function should delete the DATABASE and also the Database USER. Should return the space available in BYTES. If a string is returned it will be assumed that the user has unlimited space.<\/p>\n\n\n\n Add a CRON job for a script. Delete a CRON job of a installation. Softaculous has a CRON job that downloads the SCRIPTS from our servers and keeps them uptodate. It is located at :<\/p>\n\n\n\n You can put a file \/etc\/cron.d\/softaculous<\/strong> with the following contents :<\/p>\n\n\n\n Just unzip the new integrating.zip on to your \/path\/to\/softaculous\/<\/p>\n\n\n\n
https:\/\/api.softaculous.com\/updates.php?version=latest&panel=custom&give=1<\/a><\/p>\n\n\n\n
https:\/\/files.softaculous.com\/integrating.zip<\/a>
<\/p>\n\n\n\ncustom.zip<\/h4>\n\n\n\n
\/usr\/local\/softaculous<\/pre>\n\n\n\n
<\/p>\n\n\n\n
So if you extract your files to \/usr\/local\/softaculous the enduser folder is located at \/usr\/local\/softaculous\/enduser\/<\/strong>. This is the User Interface of Softaculous for the ENDUSER.
Also it is very important that apache OR your webserver should be RUNNING as the UNIX user of the LOGGED in user e.g. if user username<\/strong> is logging into your Control Panel and visiting Softaculous, apache should run as user username<\/strong>. This is necessary in order to be able to unzip the files in the users directories.<\/p>\n\n\n\nintegrating.zip<\/h4>\n\n\n\n
1) universal.php – PHP File which is the config
2) softpanel.php – a Class which will interact with your panel
<\/p>\n\n\n\n
There are 4 includes folder in Softaculous package includes52, includes53, includes56 and includes71, the file will be loaded from the appropriate folder based on the PHP version Softaculous is running on. You can copy the same file in all 4 includes folders.<\/p>\n\n\n\nUnderstanding universal.php<\/h3>\n\n\n\n
<?php\n\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\n\/\/===========================================================\n\/\/ universal.php\n\/\/===========================================================\n\/\/ SOFTACULOUS \n\/\/ Version : 1.1\n\/\/ Inspired by the DESIRE to be the BEST OF ALL\n\/\/ ----------------------------------------------------------\n\/\/ Started by: Alons\n\/\/ Date: 10th Jan 2009\n\/\/ Time: 21:00 hrs\n\/\/ Site: http:\/\/www.softaculous.com\/ (SOFTACULOUS)\n\/\/ ----------------------------------------------------------\n\/\/ Please Read the Terms of use at http:\/\/www.softaculous.com\n\/\/ ----------------------------------------------------------\n\/\/===========================================================\n\/\/ (c)Softaculous Inc.\n\/\/===========================================================\n\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\n\nif(!defined('SOFTACULOUS')){\n\n\tdie('Hacking Attempt');\n\n}\n\n$globals['path'] = '\/usr\/local\/softaculous'; \/\/ Where the Softaculous folder exists.\n$globals['softscripts'] = '\/var\/softaculous'; \/\/ Where the script packages are going to be stored\n$globals['sn'] = 'Softaculous';\n$globals['cookie_name'] = 'SOFTCookies817';\n$globals['gzip'] = 1;\n$globals['language'] = 'english';\n$globals['soft_email'] = 'admin@softaculous.com';\n$globals['theme_folder'] = 'default';\n$globals['timezone'] = 0;\n$globals['mail'] = 1;\n$globals['mail_server'] = '';\n$globals['mail_port'] = '';\n$globals['mail_user'] = '';\n$globals['mail_pass'] = '';\n$globals['off'] = 0;\n$globals['off_subject'] = '';\n$globals['off_message'] = '';\n$globals['update'] = 1;\n$globals['update_softs'] = 1;\n$globals['add_softs'] = 1;\n$globals['email_update'] = 1;\n$globals['email_update_softs'] = 1;\n$globals['cron_time'] = '1 8 * * *';\n$globals['chmod_files'] = '';\n$globals['chmod_dir'] = '';\n$globals['is_vps'] = 0;\n$globals['logo_url'] = '';\n$globals['php_bin'] = '';\n\n$globals['enduser'] = $globals['path'].'\/enduser';\n$globals['mainfiles'] = $globals['enduser'].'\/main';\n$globals['adminfiles'] = $globals['mainfiles'].'\/admin';\n$globals['euthemes'] = $globals['enduser'].'\/themes';\n\n?><\/pre>\n\n\n\nExplanation of Important Variables<\/h4>\n\n\n\n
$globals[‘softscripts’]<\/strong> – Is the Path where Softaculous Script Packages will be stored
$globals[‘sn’]<\/strong> – sn<\/strong> = Site Name<\/strong> that will be shown in the browser
$globals[‘cookie_name’]<\/strong> – The Cookie Name which will be used by softaculous when cookies are created
$globals[‘gzip’]<\/strong> – Output in COMPRESSED FORMAT to the BROWSER if the BROWSER supports it
$globals[‘language’]<\/strong> – The default language folder. Should be available in \/path\/to\/softaculous\/enduser\/languages\/LANGUAGE_NAME
$globals[‘soft_email’]<\/strong> – The ADMIN Email address for CRON email notifications and other notifications
<\/p>\n\n\n\nUnderstanding softpanel.php<\/h3>\n\n\n\n
<\/p>\n\n\n\nFunctions of the Softpanel Class<\/h4>\n\n\n\n
function softpanel()<\/h5>\n\n\n\n
function softpanel(){\n\tglobal $cpanel;\n\t\n\t\/\/Some Theme Settings\n\t$this->theme['softimages'] = 'softimages';\/\/ Relative to the accessed URL\n\t$this->theme['url'] = 'themes';\/\/ Relative to the accessed URL\n\t$this->theme['admin_url'] = 'enduser\/themes';\/\/ Relative to the accessed URL\n\t$this->theme['logout'] = '\/logout\/'; \/\/ Relative to the accessed URL\n\t$this->theme['panel_url'] = '\/'; \/\/ Relative to the accessed URL\n\t\n\t\/\/ Are you a Dedicated or Virtual Server\n\t$this->env = '';\n\t\n\tif(defined('SOFTADMIN')) return true;\n\n\t\/\/Load the Raw Data\n\t$this->rawdata = $this->rawdata();\n\t\n\t\/\/Load the Data\n\t$this->user = $this->userdata();\n\t$this->domainroots = $this->domainroots();\n\t$this->spaceremain = $this->spaceremain();\n\n}<\/pre>\n\n\n\n
$this->theme is an array to adjust the theme location so that you can modify the URL of static theme files.
It also loads up the variables :
$this->user<\/strong> – An array of the user information. See function userdata()<\/strong>
<\/p>\n\n\n\n
<\/p>\n\n\n\nfunction rawdata()<\/h5>\n\n\n\n
function rawdata(){\n \/\/ Any data you want to load first\n}<\/pre>\n\n\n\nfunction userdata()<\/h5>\n\n\n\n
function userdata(){\n\n\t$user = array();\n\t$user['name'] = 'username'; \/\/ Username of the account used for MySQL purposes\n\t$user['displayname'] = 'thedisplayname';\/\/ For displaying the actual name\n\t$user['email'] = 'email@address.com'; \/\/ Email of the account\n\t$user['domain'] = 'domain.com'; \/\/ Primary Domain of the account\n\t$user['homedir'] = '\/home\/username';\/\/ Home Dir of the account\n\t\n\t\/\/ Softaculous will create a DIRECTORY in this path and files in that DIRECTORY\n\t\/\/ e.g. $this->rawdata['homedir']\/.softaculous\/files.php\n\t$user['softdir'] = '\/home\/username';\n\t\n\treturn $user;\n\t\n}<\/pre>\n\n\n\nfunction domainroots()<\/h5>\n\n\n\n
\/\/ Should return the paths of all domains under this account\nfunction domainroots(){\n\t\n\t$array = array();\n\t\n\t\/\/The Default Domain with public_html\n\t$array['domain.com'] = '\/home\/username\/public_html';\n\t$array['sub.domain.com'] = '\/home\/username\/public_html\/sub'; \/\/ E.g. of a sub domain\n\t\t\t\n\treturn $array;\n\t\n}<\/pre>\n\n\n\nfunction dbhost()<\/h5>\n\n\n\n
\/\/The Host of the Database\nfunction dbhost($type = 'mysql'){\n\treturn 'localhost'; \/\/ If any other host please return that!\t\n}<\/pre>\n\n\n\nfunction maxdb()<\/h5>\n\n\n\n
\/\/The Maximum Number of Database\nfunction maxdb($type = 'mysql'){\n\t\n\treturn 100000; \/\/ The max number of DBs allowed to this user. If a string is given it will be assumed as Unlimited!\n\n}<\/pre>\n\n\n\nfunction dbsused()<\/h5>\n\n\n\n
\/\/ Number of dbs used\n\/\/ If unlimited return a string\nfunction dbsused(){\t\t\n\treturn $this->rawdata['currentMysqlDatabases'];\n}<\/pre>\n\n\n\nfunction dbname()<\/h5>\n\n\n\n
\/\/ Return the DBNAME as per the panel\n\/\/ e.g if dbname is given and a prefix is required then please give it here\nfunction dbname($dbname){\t\t\n\treturn $dbname;\t\t\n}<\/pre>\n\n\n\nfunction dbuser()<\/h5>\n\n\n\n
\/\/ Return the DBUSERNAME as per the panel\n\/\/ e.g if dbusername is given and a prefix is required then please give it here\nfunction dbuser($dbuser){\n\treturn $dbuser;\t\t\n}<\/pre>\n\n\n\nfunction dbexists()<\/h5>\n\n\n\n
\/\/ Check whether the Database Exists
\/\/ Return true if it exists or false it doesnt
function dbexists($dbname){
\t$res = soft_mysql_query(\"SHOW DATABASES LIKE '$dbname'\", $this->conn['conn']);
\tif(soft_mysql_num_rows($res) > 0){
\t\treturn true;
\t}
\treturn false;
}<\/pre>\n\n\n\nfunction dbuserexists()<\/h5>\n\n\n\n
\/\/ Check whether the Database User Exists
\/\/ Return true if it exists or false it doesnt
function dbuserexists($dbuser){
\t$res = soft_mysql_query(\"SELECT User FROM mysql.user
\t\t\t\t\t\tWHERE User = '$dbuser'\", $this->conn['conn']);
\tif(soft_mysql_num_rows($res) > 0){
\t\treturn true;
\t}
\treturn false;
}<\/pre>\n\n\n\nfunction createdb()<\/h5>\n\n\n\n
\/\/This will create a Database\nfunction createdb($dbname, $dbuser, $dbpass, $type = 'mysql'){\n\n\t\/\/ This should create a Database and its user when called\n\t\n\treturn true;\n\t\n}<\/pre>\n\n\n\n
Parameters :
<\/p>\n\n\n\n\n
function deldb()<\/h5>\n\n\n\n
\/\/Delete a Database and user\nfunction deldb($dbname, $dbuser, $type = 'mysql'){\n\n\t\/\/ This should delete a Database and its user when called\n\t\n\treturn true;\n\n}<\/pre>\n\n\n\n
Parameters passed :
<\/p>\n\n\n\n\n
function spaceremain()<\/h5>\n\n\n\n
\/\/Shows the Disk Space Available\nfunction spaceremain(){\n\t\n\t\/\/ Note: 1) Should be in BYTES\n\t\/\/\t\t 2) If it is not numeric then SOFTACULOUS will assume as UNLIMITED space\n\t\n\t$space = (1024*1024*1024); \/\/ e.g. of a GB\n\t\n\treturn $space;\n\t\n}<\/pre>\n\n\n\nfunction addcron()<\/h5>\n\n\n\n
\/\/ Add a CRON JOB\nfunction addcron($min, $hour, $day, $month, $weekday, $command, $mail = ''){\t\n\t\n\treturn true;\n\t\n}<\/pre>\n\n\n\n
Parameters passed :
<\/p>\n\n\n\n\n
function delcron()<\/h5>\n\n\n\n
\/\/ Deletes a CRON JOB as per the command given\nfunction delcron($command){\n\n\treturn true;\n\t\n}<\/pre>\n\n\n\n
Parameters passed :
<\/p>\n\n\n\n\n
Softaculous CRON<\/h3>\n\n\n\n
\/path\/to\/softaculous\/cron.php<\/pre>\n\n\n\n
1 8 * * * root \/usr\/bin\/php \/path\/to\/softaculous\/cron.php >> \/dev\/null 2>&1<\/pre>\n\n\n\n
Upgrading<\/h3>\n\n\n\n