omv6:omv6_plugins:docker_compose

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
omv6:omv6_plugins:docker_compose [2023/12/28 10:11] – [Compose Files] chenteomv6:omv6_plugins:docker_compose [2024/04/27 17:22] (current) – chente
Line 1: Line 1:
-{{indexmenu_n>3}}+{{indexmenu_n>4}}
 \\ \\
 +
 +<html><center><span style="font-size:150%;">
 +<b>Link to</b> → <a href="https://wiki.omv-extras.org/doku.php?id=omv7:omv7_plugins:docker_compose">(Docker) Compose Plugin For OMV7</a><br>
 +<br/></span></center></html>
 +
 <html><center><b>(Docker) Compose Plugin For OMV6</b></center></html> <html><center><b>(Docker) Compose Plugin For OMV6</b></center></html>
  
Line 64: Line 69:
 {{ :omv6:omv6_plugins:compose1.jpg?direct&600 |Settings}} {{ :omv6:omv6_plugins:compose1.jpg?direct&600 |Settings}}
 \\ \\
-If you are configuring the plugin for the first time you can configure all the parameters and then press the **Save** button and accept the changes. If you are simply modifying a parameter do so and press the **Save** button below.+  * If you are configuring the plugin for the first time you can configure all the parameters and then press the **Save** button and accept the changes. If you are simply modifying a parameter do so and press the **Save** button below. 
 +  * Since the openmediavault-sharerootfs plugin is a dependency of the openmediavault-compose plugin, you can create the different shared folders in the root of the OMV system disk if necessary.
 \\ \\
 === Compose Files === === Compose Files ===
Line 73: Line 79:
     * In the **Shared Folder** field select a shared folder.     * In the **Shared Folder** field select a shared folder.
       * You can choose a shared folder if you have already created it or create it directly by pressing the "**+**" button on the right.       * You can choose a shared folder if you have already created it or create it directly by pressing the "**+**" button on the right.
-      * Since the openmediavault-sharerootfs plugin is a dependency of the openmediavault-compose plugin, you can create this folder in the root of the OMV system disk if you need to do so. 
     * By default these folders and files will be created with permissions restricted to root only. If you need to customize these permissions you can do so through the rest of the available fields. These permissions will not affect subfolders belonging to volumes with relative paths.     * By default these folders and files will be created with permissions restricted to root only. If you need to customize these permissions you can do so through the rest of the available fields. These permissions will not affect subfolders belonging to volumes with relative paths.
     * Click the **Save** button if you have already finished configuring the parameters in this tab.     * Click the **Save** button if you have already finished configuring the parameters in this tab.
Line 84: Line 89:
   * The plugin will use this path if we use the CHANGE_TO_COMPOSE_DATA_PATH string in any compose file. This behavior is similar to that of a global environment variable.   * The plugin will use this path if we use the CHANGE_TO_COMPOSE_DATA_PATH string in any compose file. This behavior is similar to that of a global environment variable.
   * To define this folder do the following:   * To define this folder do the following:
-    * In the Shared Folder field select a shared folder.+    * In the **Shared Folder** field select a shared folder.
       * You can choose a shared folder if you have already created it or create it directly by pressing the “+” button on the right.       * You can choose a shared folder if you have already created it or create it directly by pressing the “+” button on the right.
     * Click the **Save** button if you have already finished configuring the parameters in this tab.     * Click the **Save** button if you have already finished configuring the parameters in this tab.
Line 100: Line 105:
         * Volumes of type '':ro'' will never be included regardless.         * Volumes of type '':ro'' will never be included regardless.
       * Typing ''# SKIP_BACKUP'' at the end of the line that defines a volume will exclude that volume in the backup.       * Typing ''# SKIP_BACKUP'' at the end of the line that defines a volume will exclude that volume in the backup.
 +  * Click the **Save** button if you have already finished configuring the parameters in this tab.
  
 ---- ----
Line 615: Line 621:
 ---- ----
  
-===== Schedule =====+===== Schedule (Updates and Backups) =====
  
 {{ :omv6:omv6_plugins:compose12.jpg?direct&400|Backup}} {{ :omv6:omv6_plugins:compose12.jpg?direct&400|Backup}}
Line 762: Line 768:
 === How to generate a composition yaml file with Autocompose === === How to generate a composition yaml file with Autocompose ===
 \\ \\
-  * Go to **Services** > **Compose** > **Files** and press the **Autocompose** button+  * Go to **Services** > **Compose** > **Files** and press the **+** and then the **Autocompose** button
   * Expand the **Container** field. A list of all running containers will appear, select the container you want to generate a //yaml// file for.   * Expand the **Container** field. A list of all running containers will appear, select the container you want to generate a //yaml// file for.
     * In the **Name** field, type the name you want to use for the generated file.     * In the **Name** field, type the name you want to use for the generated file.
  • omv6/omv6_plugins/docker_compose.1703758275.txt.gz
  • Last modified: 2023/12/28 10:11
  • by chente