".print_r($m,true)."";}; function prepareDir($dir){ if (strlen($dir)){ if ( ! is_dir($dir) && ! is_file($dir)){ mkdir($dir, 0777, true); chown($dir, 'nobody'); chgrp($dir, 'users'); sleep(1); } } } function ContainerExist($container){ global $DockerClient; $all_containers = $DockerClient->getDockerContainers(); if ( ! $all_containers) { return FALSE; } foreach ($all_containers as $ct) { if ($ct['Name'] == $container){ return True; break; } } return False; } function ImageExist($image){ global $DockerClient; $all_images = $DockerClient->getDockerImages(); if ( ! $all_images) { return FALSE; } foreach ($all_images as $img) { if ( ! is_bool(strpos($img['Tags'][0], $image)) ){ return True; break; } } return False; } function trimLine($text){ return preg_replace("/([\n^])[\s]+/", '$1', $text); } $pullecho = function($line) { global $alltotals; $cnt = json_decode( $line, TRUE ); $id = ( isset( $cnt['id'] )) ? $cnt['id'] : ""; $status = ( isset( $cnt['status'] )) ? $cnt['status'] : ""; if (strlen(trim($status)) && strlen(trim($id))) { if ( isset($cnt['progressDetail']['total']) && $cnt['progressDetail']['total'] > 0 ) { $alltotals[$cnt['id']] = $cnt['progressDetail']['total']; } echo "\n"; @flush(); } if ($status == "Downloading") { $total = $cnt['progressDetail']['total']; $current = $cnt['progressDetail']['current']; $alltotals[$cnt['id']] = $cnt['progressDetail']['current']; if ($total > 0) { $percentage = round(($current/$total) * 100); echo "\n"; } else { // Docker must not know the total download size (http-chunked or something?) // just show the current download progress without the percentage echo "\n"; } @flush(); } }; function pullImage($image) { global $DockerClient, $pullecho, $alltotals; $alltotals = array(); if (! preg_match("/:[\w]*$/i", $image)) $image .= ":latest"; readfile("/usr/local/emhttp/plugins/dynamix.docker.manager/log.htm"); echo ""; @flush(); $DockerClient->pullImage($image, $pullecho); echo "\n"; } function sizeToHuman($size) { $units = ['B','KB','MB','GB']; $unitsIndex = 0; while ($size > 1024 && (($unitsIndex+1) < count($units))) { $size /= 1024; $unitsIndex++; } return ceil($size) . " " . $units[$unitsIndex]; } function xml_encode($string) { return htmlspecialchars($string, ENT_XML1, 'UTF-8'); } function xml_decode($string) { return strval(html_entity_decode($string, ENT_XML1, 'UTF-8')); } function postToXML($post, $setOwnership = FALSE){ $dom = new domDocument; $dom->appendChild($dom->createElement( "Container" )); $xml = simplexml_import_dom( $dom ); $xml["version"] = 2; $xml->Name = xml_encode($post['contName']); $xml->Repository = xml_encode($post['contRepository']); $xml->Registry = xml_encode($post['contRegistry']); $xml->Network = xml_encode($post['contNetwork']); $xml->Privileged = (strtolower($post["contPrivileged"]) == 'on') ? 'true' : 'false'; $xml->Support = xml_encode($post['contSupport']); $xml->Overview = xml_encode($post['contOverview']); $xml->Category = xml_encode($post['contCategory']); $xml->WebUI = xml_encode($post['contWebUI']); $xml->Icon = xml_encode($post['contIcon']); $xml->ExtraParams = xml_encode($post['contExtraParams']); # V1 compatibility $xml->Description = xml_encode($post['contOverview']); $xml->Networking->Mode = xml_encode($post['contNetwork']); $xml->Networking->addChild("Publish"); $xml->addChild("Data"); $xml->addChild("Environment"); for ($i = 0; $i < count($post["confName"]); $i++) { $Type = $post['confType'][$i]; $config = $xml->addChild('Config'); $config->{0} = xml_encode($post['confValue'][$i]); $config['Name'] = xml_encode($post['confName'][$i]); $config['Target'] = xml_encode($post['confTarget'][$i]); $config['Default'] = xml_encode($post['confDefault'][$i]); $config['Mode'] = xml_encode($post['confMode'][$i]); $config['Description'] = xml_encode($post['confDescription'][$i]); $config['Type'] = xml_encode($post['confType'][$i]); $config['Display'] = xml_encode($post['confDisplay'][$i]); $config['Required'] = xml_encode($post['confRequired'][$i]); $config['Mask'] = xml_encode($post['confMask'][$i]); # V1 compatibility if ($Type == "Port"){ $port = $xml->Networking->Publish->addChild("Port"); $port->HostPort = $post['confValue'][$i]; $port->ContainerPort = $post['confTarget'][$i]; $port->Protocol = $post['confMode'][$i]; } else if ($Type == "Path"){ $path = $xml->Data->addChild("Volume"); $path->HostDir = $post['confValue'][$i]; $path->ContainerDir = $post['confTarget'][$i]; $path->Mode = $post['confMode'][$i]; } else if ($Type == "Variable"){ $variable = $xml->Environment->addChild("Variable"); $variable->Value = $post['confValue'][$i]; $variable->Name = $post['confTarget'][$i]; $variable->Mode = $post['confMode'][$i]; } } $dom = new DOMDocument('1.0'); $dom->preserveWhiteSpace = false; $dom->formatOutput = true; $dom->loadXML($xml->asXML()); return $dom->saveXML(); } function xmlToVar($xml) { global $var; $out = array(); $xml = (is_file($xml)) ? simplexml_load_file($xml) : simplexml_load_string($xml); $out['Name'] = xml_decode($xml->Name); $out['Repository'] = xml_decode($xml->Repository); $out['Registry'] = xml_decode($xml->Registry); $out['Network'] = (isset($xml->Network)) ? xml_decode($xml->Network) : xml_decode($xml->Network['Default']); $out['Privileged'] = xml_decode($xml->Privileged); $out['Support'] = xml_decode($xml->Support); $out['Overview'] = stripslashes(xml_decode($xml->Overview)); $out['Category'] = xml_decode($xml->Category); $out['WebUI'] = xml_decode($xml->WebUI); $out['Icon'] = xml_decode($xml->Icon); $out['ExtraParams'] = xml_decode($xml->ExtraParams); $out['Config'] = array(); if (isset($xml->Config)) { foreach ($xml->Config as $config) { $c = array(); $c['Value'] = strlen(xml_decode($config)) ? xml_decode($config) : xml_decode($config['Default']) ; foreach ($config->attributes() as $key => $value) $c[$key] = xml_decode(xml_decode($value)); $out['Config'][] = $c; } } # V1 compatibility if ($xml["version"] != "2"){ if (isset($xml->Networking->Mode)){ $out['Network'] = xml_decode($xml->Networking->Mode); } if (isset($xml->Description)) { $out['Overview'] = stripslashes(xml_decode($xml->Description)); } if (isset($xml->Networking->Publish->Port)) { $portNum = 0; foreach ($xml->Networking->Publish->Port as $port) { $portNum += 1; $out['Config'][] = array('Name' => "Port ${portNum}", 'Target' => xml_decode($port->ContainerPort), 'Default' => xml_decode($port->HostPort), 'Value' => xml_decode($port->HostPort), 'Mode' => xml_decode($port->Protocol), 'Description' => '', 'Type' => 'Port', 'Display' => 'always', 'Required' => 'true', 'Mask' => 'false', ); } } if (isset($xml->Data->Volume)) { $volNum = 0; foreach ($xml->Data->Volume as $vol) { $volNum += 1; $out['Config'][] = array('Name' => "Path ${volNum}", 'Target' => xml_decode($vol->ContainerDir), 'Default' => xml_decode($vol->HostDir), 'Value' => xml_decode($vol->HostDir), 'Mode' => xml_decode($vol->Mode), 'Description' => '', 'Type' => 'Path', 'Display' => 'always', 'Required' => 'true', 'Mask' => 'false', ); } } if (isset($xml->Environment->Variable)) { $varNum = 0; foreach ($xml->Environment->Variable as $var) { $varNum += 1; $out['Config'][] = array('Name' => "Variable ${varNum}", 'Target' => xml_decode($var->Name), 'Default' => xml_decode($var->Value), 'Value' => xml_decode($var->Value), 'Mode' => '', 'Description' => '', 'Type' => 'Variable', 'Display' => 'always', 'Required' => 'false', 'Mask' => 'false', ); } } } return $out; } function xmlToCommand($xml) { global $var; $xml = xmlToVar($xml); $cmdName = (strlen($xml['Name'])) ? '--name="' . $xml['Name'] . '"' : ""; $cmdPrivileged = (strtolower($xml['Privileged']) == 'true') ? '--privileged="true"' : ""; $cmdNetwork = '--net="'.strtolower($xml['Network']).'"'; $Volumes = array(''); $Ports = array(''); $Variables = array(''); $Devices = array(''); # Bind Time $Variables[] = 'TZ="' . $var['timeZone'] . '"'; # Add HOST_OS variable $Variables[] = 'HOST_OS="unRAID"'; foreach ($xml['Config'] as $key => $config) { $confType = strtolower(strval($config['Type'])); $hostConfig = strlen($config['Value']) ? $config['Value'] : $config['Default']; $containerConfig = strval($config['Target']); $Mode = strval($config['Mode']); if (! strlen($containerConfig)) continue; if ($confType == "path") { $Volumes[] = sprintf( '"%s":"%s":%s', $hostConfig, $containerConfig, $Mode); } elseif ($confType == 'port') { $Ports[] = sprintf("%s:%s/%s", $hostConfig, $containerConfig, $Mode); } elseif ($confType == "variable") { $Variables[] = sprintf('%s="%s"', $containerConfig, $hostConfig); } elseif ($confType == "device") { $Devices[] = '"'.$containerConfig.'"'; } } $cmd = sprintf('/plugins/dynamix.docker.manager/scripts/docker run -d %s %s %s %s %s %s %s %s %s', $cmdName, $cmdNetwork, $cmdPrivileged, implode(' -e ', $Variables), implode(' -p ', $Ports), implode(' -v ', $Volumes), implode(' --device=', $Devices), $xml['ExtraParams'], $xml['Repository']); $cmd = preg_replace('/\s+/', ' ', $cmd); return array($cmd, $xml['Name'], $xml['Repository']); } function getXmlVal($xml, $element, $attr=null, $pos=0) { $xml = (is_file($xml)) ? simplexml_load_file($xml) : simplexml_load_string($xml); $element = $xml->xpath("//$element")[$pos]; return isset($element) ? (isset($element[$attr]) ? strval($element[$attr]) : strval($element)) : ""; } function setXmlVal(&$xml, $value, $el, $attr=null, $pos=0) { global $echo; $xml = (is_file($xml)) ? simplexml_load_file($xml) : simplexml_load_string($xml); $element = $xml->xpath("//$el")[$pos]; if (! isset($element)) $element = $xml->addChild($el); if ($attr) { $element[$attr] = $value; } else { $element->{0} = $value; } $dom = new DOMDocument('1.0'); $dom->preserveWhiteSpace = false; $dom->formatOutput = true; $dom->loadXML($xml->asXML()); $xml = $dom->saveXML(); } # ██████╗ ██████╗ ██████╗ ███████╗ # ██╔════╝██╔═══██╗██╔══██╗██╔════╝ # ██║ ██║ ██║██║ ██║█████╗ # ██║ ██║ ██║██║ ██║██╔══╝ # ╚██████╗╚██████╔╝██████╔╝███████╗ # ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝ ## ## CREATE CONTAINER ## if (isset($_POST['contName'])) { $postXML = postToXML($_POST, TRUE); // Get the command line list($cmd, $Name, $Repository) = xmlToCommand($postXML); // Run dry if ($_POST['dryRun'] == "true") { echo "

XML

"; echo "
".htmlentities($postXML)."
"; echo "

COMMAND:

"; echo "
".htmlentities($cmd)."
"; echo '

'; goto END; } // Will only pull image if it's absent if (! ImageExist($Repository)) { // Pull image pullImage($Repository); } // Saving the generated configuration file. $userTmplDir = $dockerManPaths['templates-user']; if(is_dir($userTmplDir) === FALSE){ mkdir($userTmplDir, 0777, true); } if(strlen($Name)) { $filename = sprintf('%s/my-%s.xml', $userTmplDir, $Name); file_put_contents($filename, $postXML); } // Remove existing container if (ContainerExist($Name)){ // attempt graceful stop of container first $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker stop $Name"; include($dockerManPaths['plugin'] . "/include/Exec.php"); // force kill container if still running after 30 seconds $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker rm -f $Name"; include($dockerManPaths['plugin'] . "/include/Exec.php"); } // Remove old container if renamed $existing = isset($_POST['existingContainer']) ? $_POST['existingContainer'] : FALSE; if ($existing && ContainerExist($existing)){ // attempt graceful stop of container first $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker stop $existing"; include($dockerManPaths['plugin'] . "/include/Exec.php"); // force kill container if still running after 30 seconds $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker rm -f $existing"; include($dockerManPaths['plugin'] . "/include/Exec.php"); } // Injecting the command in $_GET variable and executing. $_GET['cmd'] = $cmd; include($dockerManPaths['plugin'] . "/include/Exec.php"); // Force information reload $DockerTemplates->removeInfo($Name, $Repository); $DockerUpdate->reloadUpdateStatus($Repository); echo '

'; goto END; } ## ## UPDATE CONTAINER ## if ($_GET['updateContainer']){ foreach ($_GET['ct'] as $value) { $Name = urldecode($value); $tmpl = $DockerTemplates->getUserTemplate($Name); if (! $tmpl){ echo 'Configuration not found. Was this container created using this plugin?'; continue; } $xml = file_get_contents($tmpl); list($cmd, $Name, $Repository) = xmlToCommand($tmpl); $Registry = getXmlVal($xml, "Registry"); readfile("/usr/local/emhttp/plugins/dynamix.docker.manager/log.htm"); echo ""; @flush(); $oldContainerID = $DockerClient->getImageID($Repository); // Pull image flush(); pullImage($Repository); // attempt graceful stop of container first $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker stop $Name"; include($dockerManPaths['plugin'] . "/include/Exec.php"); // force kill container if still running after 10 seconds $_GET['cmd'] = "/plugins/dynamix.docker.manager/scripts/docker rm -f $Name"; include($dockerManPaths['plugin'] . "/include/Exec.php"); $_GET['cmd'] = $cmd; include($dockerManPaths['plugin'] . "/include/Exec.php"); $newContainerID = $DockerClient->getImageID($Repository); if ( $oldContainerID and $oldContainerID != $newContainerID){ $_GET['cmd'] = sprintf("/plugins/dynamix.docker.manager/scripts/docker rmi %s", $oldContainerID); include($dockerManPaths['plugin'] . "/include/Exec.php"); } // Force information reload $DockerTemplates->removeInfo($Name, $Repository); $DockerUpdate->reloadUpdateStatus($Repository); } echo '

'; goto END; } ## ## REMOVE TEMPLATE ## if($_GET['rmTemplate']){ unlink($_GET['rmTemplate']); } ## ## LOAD TEMPLATE ## if ($_GET['xmlTemplate']) { list($xmlType, $xmlTemplate) = split(':', urldecode($_GET['xmlTemplate'])); if(is_file($xmlTemplate)){ $xml = xmlToVar($xmlTemplate); $templateName = $xml["Name"]; if ($xmlType == "default") { if (!empty($dockercfg["DOCKER_APP_CONFIG_PATH"]) && file_exists($dockercfg["DOCKER_APP_CONFIG_PATH"])) { // override /config foreach ($xml['Config'] as &$arrConfig) { if ($arrConfig['Type'] == 'Path' && strtolower($arrConfig['Target']) == '/config') { $arrConfig['Default'] = $arrConfig['Value'] = realpath($dockercfg["DOCKER_APP_CONFIG_PATH"]).'/'.$xml["Name"]; $arrConfig['Display'] = 'hidden'; } } } if (!empty($dockercfg["DOCKER_APP_UNRAID_PATH"]) && file_exists($dockercfg["DOCKER_APP_UNRAID_PATH"])) { // override /unraid $boolFound = false; foreach ($xml['Config'] as &$arrConfig) { if ($arrConfig['Type'] == 'Path' && strtolower($arrConfig['Target']) == '/unraid') { $arrConfig['Default'] = $arrConfig['Value'] = realpath($dockercfg["DOCKER_APP_UNRAID_PATH"]); $arrConfig['Display'] = 'hidden'; $boolFound = true; } } if (!$boolFound) { $xml['Config'][] = array('Name' => 'unRAID Share Path', 'Target' => '/unraid', 'Default' => realpath($dockercfg["DOCKER_APP_UNRAID_PATH"]), 'Value' => realpath($dockercfg["DOCKER_APP_UNRAID_PATH"]), 'Mode' => 'rw', 'Description' => '', 'Type' => 'Path', 'Display' => 'hidden', 'Required' => 'false', 'Mask' => 'false', ); } } } $xml['Description'] = str_replace(array('[', ']'), array('<', '>'), $xml['Overview']); echo ""; } } $showAdditionalInfo = ''; ?>
\n"; endif; else:?> > > > > > > > >
Template: "; }?>

Templates are a quicker way to setting up Docker Containers on your unRAID server. There are two types of templates:

Default templates
When valid repositories are added to your Docker Repositories page, they will appear in a section on this drop down for you to choose (master categorized by author, then by application template). After selecting a default template, the page will populate with new information about the application in the Description field, and will typically provide instructions for how to setup the container. Select a default template when it is the first time you are configuring this application.

User-defined templates
Once you've added an application to your system through a Default template, the settings you specified are saved to your USB flash device to make it easy to rebuild your applications in the event an upgrade were to fail or if another issue occurred. To rebuild, simply select the previously loaded application from the User-defined list and all the settings for the container will appear populated from your previous setup. Clicking create will redownload the necessary files for the application and should restore you to a working state. To delete a User-defined template, select it from the list above and click the red X to the right of it.

Name:

Give the container a name or leave it as default.
Overview:
Overview:
Repository:

The repository for the application on the Docker Registry. Format of authorname/appname. Optionally you can add a : after appname and request a specific version for the container image.
Network Type:

If the Bridge type is selected, the application’s network access will be restricted to only communicating on the ports specified in the port mappings section. If the Host type is selected, the application will be given access to communicate using any port on the host that isn’t already mapped to another in-use application/service. Generally speaking, it is recommended to leave this setting to its default value as specified per application template.

IMPORTANT NOTE: If adjusting port mappings, do not modify the settings for the Container port as only the Host port can be adjusted.
Privileged:

For containers that require the use of host-device access directly or need full exposure to host capabilities, this option will need to be selected. For more information, see this link: https://docs.docker.com/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration
 

A description for the application container. Supports basic HTML mark-up.
Categories:
Support Thread:

Lnk to a support thread on Lime-Technology's forum.
Docker Hub URL:

The path to the container's repository location on the Docker Hub.
Icon URL:

Link to the icon image for your application (only displayed on dashboard if Show Dashboard apps under Display Settings is set to Icons).
WebUI:

When you click on an application icon from the Docker Containers page, the WebUI option will link to the path in this field. Use [IP} to identify the IP of your host and [PORT:####] replacing the #'s for your port.
Extra Parameters:

If you wish to append additional commands to your Docker container at run-time, you can specify them here. For example, if you wish to pin an application to live on a specific CPU core, you can enter "--cpuset=0" in this field. Change 0 to the core # on your system (starting with 0). You can pin multiple cores by separation with a comma or a range of cores by separation with a dash. For all possible Docker run-time commands, see here: https://docs.docker.com/reference/run/