├── .gitignore
├── LICENSE
├── README.md
├── archive
    ├── composerize-2022.08.07.txz
    └── composerize-20231029.txz
├── build.sh
├── plugin
    ├── composerize.plg
    └── composerize.png
└── source
    └── composerize
        └── usr
            └── local
                └── emhttp
                    └── plugins
                        └── composerize
                            ├── Composerize.page
                            ├── README.md
                            ├── api.php
                            ├── images
                                └── composerize.png
                            ├── include
                                └── composerize.php
                            └── js
                                └── composerize.min.js


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | *.bak
3 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022 Liam Lalonde
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # unraid-plugin-composerize
2 | 
3 | Automatically convert community application docker templates to compose stacks
4 | using [composerize](https://github.com/magicmark/composerize).
5 | 
6 | Required plugins:
7 | 
8 | - [Compose.Manager](https://forums.unraid.net/topic/114415-plugin-docker-compose-manager/)
9 | - [Community Applications](https://forums.unraid.net/topic/38582-plug-in-community-applications/)


--------------------------------------------------------------------------------
/archive/composerize-2022.08.07.txz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/llalon/unraid-plugin-composerize/86748bc6fd771ca83276282e39efc17bfd9136de/archive/composerize-2022.08.07.txz


--------------------------------------------------------------------------------
/archive/composerize-20231029.txz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/llalon/unraid-plugin-composerize/86748bc6fd771ca83276282e39efc17bfd9136de/archive/composerize-20231029.txz


--------------------------------------------------------------------------------
/build.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | 
  3 | # Detect MAC OSX
  4 | if [ "$(uname)" == "Darwin" ]; then
  5 |   PREFIX="g"
  6 | else
  7 |   PREFIX=""
  8 | fi
  9 | 
 10 | set -e
 11 | 
 12 | USAGE="Usage: $(basename "$0") <plugin> [branch] [version]"
 13 | ARCHIVE_DIR="./archive"
 14 | SOURCE_DIR="./source"
 15 | 
 16 | PLUGIN_FILE="$1"
 17 | BRANCH="$2"
 18 | VERSION="$3"
 19 | 
 20 | # Validate arguments
 21 | if [ "$#" -lt 1 ] || [ "$#" -gt 3 ]; then
 22 |     echo "$USAGE"
 23 |     exit 1
 24 | fi
 25 | 
 26 | if [[ $PLUGIN_FILE != *.plg ]]; then
 27 |     echo "$USAGE"
 28 |     exit 1
 29 | fi
 30 | 
 31 | if [ -z "$BRANCH" ]; then
 32 |   BRANCH="main"
 33 | fi
 34 | 
 35 | if [ -z "$VERSION" ]; then
 36 |   VERSION=$(date +%Y%m%d)
 37 | fi
 38 | 
 39 | # Extract name from plugin file - source dir must match
 40 | NAME=$("${PREFIX}sed" -n 's/<!ENTITY[[:space:]]\+name[[:space:]]\+"\(.*\)">/\1/p' "$PLUGIN_FILE")
 41 | if [ -z "$NAME" ]; then
 42 |     echo "Error: Pattern not found in the file."
 43 |     exit 1
 44 | fi
 45 | 
 46 | FILE_NAME="$NAME-$VERSION.txz"
 47 | PACKAGE_DIR="$SOURCE_DIR/$NAME"
 48 | 
 49 | # Validate source
 50 | if [ -d "$PACKAGE_DIR" ]; then
 51 |     if [ -z "$(ls -A "$PACKAGE_DIR")" ]; then
 52 |         echo "Folder exists but is empty."
 53 |         exit 1
 54 |     fi
 55 | else
 56 |     echo "Folder does not exist."
 57 |     exit 1
 58 | fi
 59 | 
 60 | echo "================================================"
 61 | echo "           Building UnRaid plugin package"
 62 | echo "================================================"
 63 | echo "Plugin: ${PLUGIN_FILE}"
 64 | echo "Name: ${NAME}"
 65 | echo "Source: ${PACKAGE_DIR}"
 66 | echo "Archive: ${ARCHIVE_DIR}"
 67 | echo "================================================"
 68 | 
 69 | mkdir -p "$ARCHIVE_DIR"
 70 | FILE="$(realpath ${ARCHIVE_DIR})/$FILE_NAME"
 71 | 
 72 | 
 73 | pushd "$PACKAGE_DIR"
 74 |   echo "Setting file permissions..."
 75 |   find usr -type f -exec dos2unix {} \;
 76 |   chmod -R 755 usr/
 77 | 
 78 |   echo "Creating archive..."
 79 |   "${PREFIX}tar" -cJf "$FILE" --owner=0 --group=0 usr/
 80 | popd
 81 | 
 82 | echo "Verifying package"
 83 | if [ -f "$FILE" ]; then
 84 |   hash=$(md5sum "$FILE" | cut -f 1 -d " ")
 85 | 
 86 |   if [ -z "$hash" ]; then
 87 |     echo "Could not verify archive"
 88 |     exit 1
 89 |   fi
 90 | 
 91 |   echo "Packaged successfully: ${hash}"
 92 | 
 93 |   echo "Updating plugin info..."
 94 |   "${PREFIX}sed" -i.bak '/'"<!ENTITY md5"'/s/.*/'"<!ENTITY md5 \"${hash}\">"'/' "${PLUGIN_FILE}"
 95 |   "${PREFIX}sed" -i.bak '/'"<!ENTITY version"'/s/.*/'"<!ENTITY version \"${VERSION}\">"'/' "${PLUGIN_FILE}"
 96 |   "${PREFIX}sed" -i.bak '/'"<!ENTITY branch"'/s/.*/'"<!ENTITY branch \"${BRANCH}\">"'/' "${PLUGIN_FILE}"
 97 | else
 98 |   echo "Failed to build package!"
 99 | fi
100 | 
101 | echo "Done."


--------------------------------------------------------------------------------
/plugin/composerize.plg:
--------------------------------------------------------------------------------
 1 | <?xml version='1.0' standalone='yes'?>
 2 | <!DOCTYPE PLUGIN [
 3 | <!ENTITY name       "composerize">
 4 | <!ENTITY launch     "Settings/Composerize">
 5 | <!ENTITY author     "llalon">
 6 | <!ENTITY version "20231029">
 7 | <!ENTITY branch "main">
 8 | <!ENTITY file       "&name;-&version;.txz">
 9 | <!ENTITY github     "llalon/unraid-plugin-composerize">
10 | <!ENTITY repo       "https://github.com/&github;">
11 | <!ENTITY releaseURL "https://raw.githubusercontent.com/&github;/&branch;">
12 | <!ENTITY pluginURL  "&releaseURL;/archive/&file;">
13 | <!ENTITY pluginURL  "&releaseURL;/plugin/&name;.plg">
14 | <!ENTITY md5 "9d08e6834ac5ce6a864a63b5c6e2276f">
15 | ]>
16 | 
17 | <PLUGIN name="&name;" author="&author;" version="&version;" launch="&launch;" pluginURL="&pluginURL;" support="&repo;">
18 | 
19 | <CHANGES>
20 | ### 2023.11.01
21 | - General enhancements and bug fixes
22 | - Moved composerize to client side.
23 | ### 2022.08.01
24 | - Initial Release
25 | </CHANGES>
26 | 
27 | <FILE Run="/bin/bash">
28 | <INLINE>
29 | rm -f $(ls /boot/config/plugins/&name;/&name;*.txz 2>/dev/null|grep -v '&version;')
30 | </INLINE>
31 | </FILE>
32 | 
33 | <FILE Name="/boot/config/plugins/&name;/&file;" Run="upgradepkg --install-new">
34 | <URL>&releaseURL;/archive/&file;</URL>
35 | <MD5>&md5;</MD5>
36 | </FILE>
37 | 
38 | <FILE Run="/bin/bash">
39 | <INLINE>
40 | echo ""
41 | echo "----------------------------------------------------"
42 | echo " &name; has been installed."
43 | echo " Version: &version;"
44 | echo ""
45 | echo " This plugin required docker and docker compose plugins to be installed."
46 | echo "----------------------------------------------------"
47 | echo ""
48 | </INLINE>
49 | </FILE>
50 | 
51 | <FILE Run="/bin/bash" Method="remove">
52 | <INLINE>
53 | removepkg &name;-&version;
54 | rm -r /usr/local/emhttp/plugins/&name;
55 | rm -r /boot/config/plugins/&name;
56 | </INLINE>
57 | </FILE>
58 | 
59 | </PLUGIN>


--------------------------------------------------------------------------------
/plugin/composerize.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/llalon/unraid-plugin-composerize/86748bc6fd771ca83276282e39efc17bfd9136de/plugin/composerize.png


--------------------------------------------------------------------------------
/source/composerize/usr/local/emhttp/plugins/composerize/Composerize.page:
--------------------------------------------------------------------------------
  1 | Title="Composerize"
  2 | Icon="composerize.png"
  3 | Type="xmenu"
  4 | Menu="Utilities"
  5 | ---
  6 | 
  7 | <?php
  8 | $docroot = $docroot ?: $_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp';
  9 | $pluginRoot = '/plugins/composerize';
 10 | 
 11 | include $docroot . $pluginRoot . '/include/composerize.php';
 12 | ?>
 13 | 
 14 | <script src="<?= $pluginRoot; ?>/js/composerize.min.js"></script>
 15 | <script>
 16 |     $(document).ready(function () {
 17 |         const templateSelect = $('#composerize-select');
 18 |         const composeText = $('#compose-text');
 19 |         const resetButton = $('#reset-button');
 20 |         const undoButton = $('#undo-button');
 21 |         const submitButton = $('#submit-button');
 22 | 
 23 |         templateSelect.on('change', function () {
 24 |             const value = this.value;
 25 |             const compose = value ? composerize(value) : "";
 26 |             submitButton.prop("disabled", value == false);
 27 |             composeText.val(compose);
 28 | 
 29 |             // Enable undo
 30 |             undoButton.on('click', function () {
 31 |                 composeText.val(compose);
 32 |             });
 33 |         });
 34 | 
 35 |         submitButton.on('click', function () {
 36 |             const name = templateSelect.find('option:selected').text();
 37 |             const compose = composeText.val();
 38 | 
 39 |             const makeRequest = (force) => $.ajax({
 40 |                 type: "POST",
 41 |                 url: "<?=$pluginRoot;?>/api.php",
 42 |                 dataType: 'json',
 43 |                 data: {
 44 |                     'name': name,
 45 |                     'compose': compose,
 46 |                     'force': force
 47 |                 },
 48 |                 success: function (response) {
 49 |                     const status = response.status;
 50 | 
 51 |                     if (status === "exists" && force === false) {
 52 |                         swal({
 53 |                             title: "Are you sure?",
 54 |                             text: "A docker compose stack already exists. Would you like to overwrite?",
 55 |                             icon: "success",
 56 |                             showCancelButton: true,
 57 |                             confirmButtonText: "Yes",
 58 |                             cancelButtonText: "No",
 59 |                             closeOnConfirm: false,
 60 |                             closeOnCancel: true
 61 |                         }, function (confirm) {
 62 |                             if (confirm) {
 63 |                                 makeRequest(true);
 64 |                             }
 65 |                         });
 66 |                     } else if (status === "success") {
 67 |                         swal({
 68 |                             title: "Success!",
 69 |                             text: "Docker compose saved to disk.",
 70 |                             icon: "success"
 71 |                         });
 72 |                     } else {
 73 |                         swal({
 74 |                             title: "Error!",
 75 |                             text: "Unable to save compose to disk.",
 76 |                             icon: "error"
 77 |                         });
 78 |                     }
 79 |                 },
 80 |                 error: function (jqXHR, status, errorThrown) {
 81 |                     console.log(jqXHR, status, errorThrown);
 82 |                     if (status >= 500) {
 83 |                         swal({
 84 |                             title: "Error!",
 85 |                             text: "There was an error.",
 86 |                             icon: "error"
 87 |                         });
 88 |                     } else {
 89 |                         swal({
 90 |                             title: "Error!",
 91 |                             text: "Compose is invalid.",
 92 |                             icon: "error"
 93 |                         });
 94 |                     }
 95 |                 }
 96 |             });
 97 | 
 98 |             // Initially make the request with force off
 99 |             // Prompt user if they wish to overwrite
100 |             // Run function again with this set to true
101 |             makeRequest(false);
102 |         });
103 | 
104 |         resetButton.on('click', function () {
105 |             window.location.reload();
106 |         });
107 | 
108 |         console.log("Plugin Ready!");
109 |     });
110 | </script>
111 | 
112 | <div style="display: flex;">
113 | 
114 |     <!-- selector side -->
115 |     <div style="float: left; padding: 10px; width: 25%;">
116 |         <h2>Template</h2>
117 |         <select id="composerize-select" style="width: 100%;">
118 |             <option value="" selected="selected">Choose One</option>
119 |             <?php foreach (getDockerTemplateList() as $key => $value): ?>
120 |                 <option value='<?= htmlspecialchars($value); ?>'><?= htmlspecialchars($key); ?></option>
121 |             <?php endforeach; ?>
122 |         </select>
123 |     </div>
124 |     <!-- end selector side -->
125 | 
126 |     <!-- preview side -->
127 |     <div style="float: left; padding: 10px; width: 75%;">
128 |         <h2>Preview Compose</h2>
129 |         <textarea id="compose-text" style="font-family: bitstream; width: 100%;" spellcheck="false" cols="80"
130 |                   rows="22" maxlength="8192"></textarea>
131 |         <input id="submit-button" style="float: left; margin-right: 10px;" type="button" value="Apply"/>
132 |         <input id="undo-button" style="float: left; margin-right: 10px;" type="button" value="Original"/>
133 |         <input id="reset-button" style="float: right;" type="button" value="_(Reset)_"/>
134 |     </div>
135 |     <!-- end preview side -->
136 | 
137 | </div>


--------------------------------------------------------------------------------
/source/composerize/usr/local/emhttp/plugins/composerize/README.md:
--------------------------------------------------------------------------------
1 | **Composerize**
2 | 
3 | Turns docker templates into docker-compose stacks using [Composerize](https://github.com/composerize/composerize)


--------------------------------------------------------------------------------
/source/composerize/usr/local/emhttp/plugins/composerize/api.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * Install a docker compose stack. Supports POST only with:
 5 |  *
 6 |  * - name (string): The name of the docker compose stack.
 7 |  * - compose (string): The Docker Compose YAML configuration to install.
 8 |  * - force (boolean): Will not warn if an existing stack will be overwritten if true. (Optional)
 9 |  *
10 |  * Example Response:
11 |  * {
12 |  *    "status": true,
13 |  *    "force": true
14 |  * }
15 |  */
16 | 
17 | $docroot = $docroot ?: $_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp';
18 | $pluginRoot = '/plugins/composerize';
19 | 
20 | include $docroot . $pluginRoot . '/include/composerize.php';
21 | 
22 | if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
23 |     http_response_code(405);
24 |     die();
25 | }
26 | 
27 | $name = $_POST['name'];
28 | $compose = $_POST['compose'];
29 | $force = $_POST['force'] == 'true';
30 | 
31 | if (empty($name) || empty($compose) || !isValidYaml($compose)) {
32 |     http_response_code(400);
33 |     die();
34 | }
35 | 
36 | $status = installCompose($name, $compose, $force);
37 | http_response_code(200);
38 | 
39 | header('Content-Type: application/json');
40 | die(json_encode(array(
41 |     'status' => $status,
42 |     'force' => $force
43 | )));


--------------------------------------------------------------------------------
/source/composerize/usr/local/emhttp/plugins/composerize/images/composerize.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/llalon/unraid-plugin-composerize/86748bc6fd771ca83276282e39efc17bfd9136de/source/composerize/usr/local/emhttp/plugins/composerize/images/composerize.png


--------------------------------------------------------------------------------
/source/composerize/usr/local/emhttp/plugins/composerize/include/composerize.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | const DOCKER_TEMPLATE_DIRECTORY = '/boot/config/plugins/dockerMan/templates-user/';
  4 | const COMPOSE_DIRECTORY = '/boot/config/plugins/compose.manager/projects/';
  5 | 
  6 | $docroot = $docroot ?: $_SERVER['DOCUMENT_ROOT'] ?: '/usr/local/emhttp';
  7 | 
  8 | // Initialize docker connection from dynamix docker plugin
  9 | require_once("$docroot/plugins/dynamix.docker.manager/include/DockerClient.php");
 10 | require_once("$docroot/plugins/dynamix.docker.manager/include/Helpers.php");
 11 | 
 12 | // ToDo allow for user customization
 13 | $dockerClient = new DockerClient();
 14 | $dockerUpdate = new DockerUpdate();
 15 | $dockerTemplates = new DockerTemplates();
 16 | $custom = DockerUtil::custom();
 17 | $subnet = DockerUtil::network($custom);
 18 | $cpus = DockerUtil::cpus();
 19 | 
 20 | function isValidYaml($yamlString): bool
 21 | {
 22 |     // ToDo - add better validation for yaml
 23 |     return !empty($yamlString);
 24 | }
 25 | 
 26 | function writeContentToFile($file, $content): bool
 27 | {
 28 |     try {
 29 |         $f = fopen($file, "w");
 30 |         fwrite($f, $content);
 31 |         fclose($f);
 32 | 
 33 |         return true;
 34 |     } catch (Exception $exception) {
 35 |         var_dump($exception);
 36 |         return false;
 37 |     }
 38 | }
 39 | 
 40 | /**
 41 |  * Install a compose stack to the disk.
 42 |  *
 43 |  * @param string $name docker stack name
 44 |  * @param string $compose compose yaml string
 45 |  * @param bool $force whether to force overwrite
 46 |  * @return string status "success", "failure" or "exists"
 47 |  */
 48 | function installCompose(string $name, string $compose, bool $force): string
 49 | {
 50 |     try {
 51 |         $composeProjectDirectory = COMPOSE_DIRECTORY . $name . "/";
 52 |         $composeYamlFilePath = $composeProjectDirectory . "docker-compose.yml";
 53 |         $composeNameFilePath = $composeProjectDirectory . "name";
 54 | 
 55 |         $nameFileExists = file_exists($composeNameFilePath);
 56 |         $yamlFileExists = file_exists($composeYamlFilePath);
 57 | 
 58 |         if (!$force && ($nameFileExists || $yamlFileExists)) {
 59 |             return "exists";
 60 |         }
 61 | 
 62 |         mkdir($composeProjectDirectory, 0755, true);
 63 | 
 64 |         $saveFileResultName = writeContentToFile($composeNameFilePath, $name);
 65 |         $saveFileResultYaml = writeContentToFile($composeYamlFilePath, $compose);
 66 | 
 67 |         if ($saveFileResultName && $saveFileResultYaml) {
 68 |             return "success";
 69 |         }
 70 | 
 71 |         return "failure";
 72 |     } catch (Exception $exception) {
 73 |         return "failure";
 74 |     }
 75 | }
 76 | 
 77 | /**
 78 |  * Get a list of available templates as key value pairs.
 79 |  * file =>
 80 |  *
 81 |  * @return array docker templates and run commands
 82 |  */
 83 | function getDockerTemplateList(): array
 84 | {
 85 |     $dockerTemplates = array();
 86 | 
 87 |     $files = glob(DOCKER_TEMPLATE_DIRECTORY . "*.xml");
 88 | 
 89 |     foreach ($files as $file) {
 90 |         $info = xmlToCommand($file, false);
 91 | 
 92 |         $command = str_replace("/usr/local/emhttp/plugins/dynamix.docker.manager/scripts/docker create", 'docker run', $info[0]);
 93 |         $name = $info[1];
 94 | 
 95 |         $dockerTemplates[$name] = $command;
 96 |     }
 97 | 
 98 |     return $dockerTemplates;
 99 | }
100 | 


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