omv7:omv7_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
omv7:omv7_plugins:docker_compose [2024/04/27 18:36] – [Docker in OMV - Initial Setup] chenteomv7:omv7_plugins:docker_compose [2025/07/17 13:42] (current) – [Create] chente
Line 13: Line 13:
  
 ===== Summary ===== ===== Summary =====
-[[https://docs.docker.com/compose/|{{ ::omv7:omv7_plugins:compose7-1.png?direct&200|docker compose}}]]+[[https://docs.docker.com/compose/|{{ ::omv7:omv7_plugins:compose7-1.png?direct&200|Go to -> Docker compose}}]]
   * Docker is a technology that enables the creation and use of Linux containers. A container is a closed environment where one or more applications and their dependencies are installed, grouped and isolated from each other, running on the same operating system kernel.   * Docker is a technology that enables the creation and use of Linux containers. A container is a closed environment where one or more applications and their dependencies are installed, grouped and isolated from each other, running on the same operating system kernel.
   * Docker allows you to install, uninstall, modify, update applications as many times as you want without causing damage to the system.   * Docker allows you to install, uninstall, modify, update applications as many times as you want without causing damage to the system.
Line 26: Line 26:
  
 ===== Docker in OMV - Initial Setup ===== ===== Docker in OMV - Initial Setup =====
-[[omv7:docker_in_omv|{{ :omv7:dockeromv7-1.png?direct&400 |Go to -> Docker in OMV}}]] +[[omv7:docker_in_omv|{{ :omv7:dockeromv7-1.png?direct&200|Go to -> Docker in OMV 7}}]] 
-  * [[omv7:docker_in_omv|Docker in OMV]] is a document that provides a simple and secure docker management method. This document establishes a method to successfully install a docker application on OMV. It is recommended to read it before installing docker or openmediavault-compose.+\\ 
 +[[omv7:docker_in_omv|Docker in OMV 7]] is a document that establishes a method to successfully install any application on OMV using Docker.
  
 +**It is recommended to read it before installing Docker or openmediavault-compose.** Go to -> [[omv7:docker_in_omv|Docker in OMV 7]]
  
 ---- ----
Line 83: Line 85:
   * In this field we can define a folder already created where we have the user data.   * In this field we can define a folder already created where we have the user data.
   * 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.
 +  * If you are not going to use the CHANGE_TO_COMPOSE_DATA_PATH variable you can leave this field unconfigured.
   * 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.
Line 636: Line 639:
     * If you want to have several versioned backups over time, you must make a copy later with another specialized application for this purpose.     * If you want to have several versioned backups over time, you must make a copy later with another specialized application for this purpose.
   * The containers that were running when the process started are started again. Those who were detained will continue to be detained.   * The containers that were running when the process started are started again. Those who were detained will continue to be detained.
 +  * A copy of the global environment variables file will be added to the backup. This file will be located in the folder defined for the backup and is named ''global.env''
 The update task performs the following process: The update task performs the following process:
   * Download the container images included in the compose file.   * Download the container images included in the compose file.
   * Recreate the containers with the new image if they were running.   * Recreate the containers with the new image if they were running.
-\\+
 <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#69A5FF;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#69A5FF;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note
 </span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;"> </span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
-At this time, the plug-in backup utility does not resolve variables in volume paths. Define paths using global environment variables only for paths that you do not need to include in a backup.<br> +The advantage of the plugin's backup utility is that it stops the containers before doing the backup, which is actually a simple rsync. After that is when you should use whatever specialized backup utility you want, with deduplication, versioning, etc., to backup that folder copied with rsync. If you use any backup application directly with the containers running you can get an inconsistent backup.
-Alternatively you can use symlinks in the compose file.+
 </tr></table></body></html> </tr></table></body></html>
  
Line 650: Line 653:
 === Create === === Create ===
  
-{{ :omv6:omv6_plugins:compose9.jpg?direct&400|Schedule}} +{{ :omv7:omv7_plugins:compose9.jpg?direct&400|Schedule}} 
-Opens a dialog for scheduling backup jobs.+Opens a dialog box to schedule container backup and/or update jobs.
  
   * **Settings**   * **Settings**
Line 659: Line 662:
       * Filter can be a partial match with use of wildcard (*). e.g. asd* or *asd* or *asd.       * Filter can be a partial match with use of wildcard (*). e.g. asd* or *asd* or *asd.
       * You can add multiple filters separated by commas.       * You can add multiple filters separated by commas.
 +    * File excludes: Files defined in this field will be excluded from the scheduled action to be performed. Multiple exclusions can be defined, separated by a comma.
   * **Action Type**   * **Action Type**
-    * Backup: If enabled, a backup task will be executed. +    * Maintenance: It gives access to the maintenance options and they are the following: 
-    * Update: If enabled, an update task will be executed for the selected containers. If the backup task is also checked, the backup will be performed first and then the update. Will recreate containers after update if running. +      * Backup: If enabled, a backup task will be executed. 
-    * Prune: If enabled, prune all dangling images. It does not use a filter, so all existing dangling images will be removed. Will run the ''docker image prune -f'' command.+      * Update: If enabled, an update task will be executed for the selected containers. If the backup task is also checked, the backup will be performed first and then the update. Will recreate containers after update if running. 
 +      * Prune: If enabled, prune all dangling images. It does not use a filter, so all existing dangling images will be removed. Will run the ''docker image prune -f'' command. 
 +    * Container state: Provides access to functions to stop or start one or more containers on a scheduled basis. 
 +      * Start: Starts the execution of containers included in the compose files defined in the scheduled task. 
 +      * Stop: Stops the execution of containers included in the compose files defined in the scheduled task. 
 +  * **Scripts** (Only active if maintenance mode is selected)
     * Pre-backup script field: Allows you to set the path of a custom script that will be executed before the execution of the scheduled task.     * Pre-backup script field: Allows you to set the path of a custom script that will be executed before the execution of the scheduled task.
     * Post-backup script field: Allows you to set the path of a custom script that will be executed after the execution of the scheduled task.     * Post-backup script field: Allows you to set the path of a custom script that will be executed after the execution of the scheduled task.
Line 668: Line 677:
     * Schedule the time of execution using the date and time options.     * Schedule the time of execution using the date and time options.
       * For example, the attached screenshot will backup all containers on Sundays at 8:36 AM. and will send an email with the result of the backup.       * For example, the attached screenshot will backup all containers on Sundays at 8:36 AM. and will send an email with the result of the backup.
-    * Select if you want to receive an email with the output of the work, the header will show what you write in the Comment field.+    * Send command output via email: Select if you want to receive an email with the output of the work. 
 +    * Verbose: Select whether you want the email output to be detailed. 
 +    * Comment: The header will show what you write in the Comment field.
  
 ---- ----
Line 722: Line 733:
 === How to update a single docker-compose container === === How to update a single docker-compose container ===
 \\ \\
-  * Go to **Services** > **Compose** > **Containers** and select the container you want to update.+  * Go to **Services** > **Compose** > **Services** and select the container you want to update.
   * Press the **Pull** button. This will download the latest available image from that container.   * Press the **Pull** button. This will download the latest available image from that container.
   * Now go to **Services** > **Compose** > **Files** and select the file where that container is defined.   * Now go to **Services** > **Compose** > **Files** and select the file where that container is defined.
  • omv7/omv7_plugins/docker_compose.1714243001.txt.gz
  • Last modified: 2024/04/27 18:36
  • by chente