omv8:omv8_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
omv8:omv8_plugins:docker_compose [2025/12/21 11:58] – [Usual procedures] chenteomv8:omv8_plugins:docker_compose [2026/01/11 09:06] (current) – [Usage in compose files] chente
Line 12: Line 12:
  
 ===== Summary ===== ===== Summary =====
-[[https://docs.docker.com/compose/|{{ ::omv7:omv7_plugins:compose7-1.png?direct&200|Go to -> Docker compose}}]]+[[https://docs.docker.com/compose/|{{ ::omv7:omv7_plugins:compose7-1.png?direct&300|Go to -> Docker compose}}]]
 Docker is a technology that enables the creation and use of Linux containers. A container is an isolated environment where one or more applications and their dependencies run using the same operating system kernel. Docker is a technology that enables the creation and use of Linux containers. A container is an isolated environment where one or more applications and their dependencies run using the same operating system kernel.
  
Line 67: Line 67:
 <html><center>Under <b>Services</b> > <b>Compose</b> > <b>Settings</b></center></html> <html><center>Under <b>Services</b> > <b>Compose</b> > <b>Settings</b></center></html>
  
-{{ :omv8:omv8_plugins:compose8-1.png?direct&600 |Settings}}+{{ :omv8:omv8_plugins:compose8-1.png?direct&1200 |Settings}}
 \\ \\
 This tab contains the general configuration options of the **openmediavault-compose** plugin. This tab contains the general configuration options of the **openmediavault-compose** plugin.
Line 80: Line 80:
 === Compose Files === === Compose Files ===
  
 +{{ :omv8:omv8_plugins:compose8-19.png?direct&600|Compose settings}}
 Define the folder where the plugin will store container configuration files, including Docker Compose files (''.yaml'') and environment files (''.env'').   Define the folder where the plugin will store container configuration files, including Docker Compose files (''.yaml'') and environment files (''.env'').  
  
Line 709: Line 710:
 ---- ----
  
-==== Usage in compose files ====+==== Usage in Compose Files ====
  
 Docker configs managed in this tab can be referenced inside compose files using the standard Docker Compose syntax. Docker configs managed in this tab can be referenced inside compose files using the standard Docker Compose syntax.
Line 715: Line 716:
 This allows configuration files to be mounted into containers at runtime without hardcoding their contents directly in the compose file. This allows configuration files to be mounted into containers at runtime without hardcoding their contents directly in the compose file.
  
-This functionality is recommended only for users familiar with Docker Compose and container configuration management.+**Workflow:** 
 + 
 +  * A config file is always associated with a specific Compose file. 
 +  * When you create or import a config in the GUI, it is stored in the same folder as the Compose file. 
 +  * In your Compose file, you can reference the config using its filename only, no absolute path needed. 
 +  * This allows you to keep all container configuration files in one place, simplifying management and avoiding repetitive CLI bind-mounting. 
 + 
 +**Example:** 
 + 
 +  * You create mosquitto.conf in the Configs tab and associate it with docker-compose.yml. 
 +  * The plugin stores mosquitto.conf in the same folder as the compose file. 
 +  * In docker-compose.yml, mount it like this: 
 + 
 +<code> 
 +services: 
 +  mosquitto: 
 +    image: eclipse-mosquitto 
 +    volumes: 
 +      - .mosquitto.conf:/mosquitto/config/mosquitto.conf:ro 
 + 
 +</code> 
 + 
 +**Key points:** 
 + 
 +  * Configs cannot be created outside the compose folder. 
 +  * This workflow saves CLI steps and keeps configuration files organized and easy to find. 
 +  * Recommended for users who want to manage container configs without hardcoding paths or moving files manually.
  
 ---- ----
Line 979: Line 1006:
   * **Driver**   * **Driver**
     * Choose the network driver type (bridge, overlay, macvlan, etc.).     * Choose the network driver type (bridge, overlay, macvlan, etc.).
 +      * **bridge** – standard network bridge.
 +      * **ipvlan** – network interface with minimal overhead, useful for assigning multiple IPs.
 +      * **macvlan** – assign a MAC address to each container; allows containers to appear as separate devices on the LAN.
 +      * **overlay** – network for multi-host container communication.
 +  * **Parent Network** (only for macvlan)
 +    * Select the physical network interface on the host that will act as the parent for the macvlan network.
   * **Subnet**   * **Subnet**
     * Define the subnet in CIDR notation (e.g., 172.20.0.0/16).     * Define the subnet in CIDR notation (e.g., 172.20.0.0/16).
Line 987: Line 1020:
   * **Aux Address**   * **Aux Address**
     * Optional static IP assignments in the format `name=ip`.       * Optional static IP assignments in the format `name=ip`.  
-      Comma separate multiple entries (e.g., `my-router=192.168.10.5,my-nas=192.168.20.6`).+    * Comma separate multiple entries (e.g., `my-router=192.168.10.5,my-nas=192.168.20.6`).
   * **Save**   * **Save**
     * Creates the network with the defined parameters.     * Creates the network with the defined parameters.
Line 1184: Line 1217:
 {{ :omv8:omv8_plugins:compose8-16.png?direct&1200 |Schedule}} {{ :omv8:omv8_plugins:compose8-16.png?direct&1200 |Schedule}}
  
-{{ :omv8:omv8_plugins:compose8-17.png?direct&400|Backup}}+{{ :omv8:omv8_plugins:compose8-17.png?direct&600|Backup}}
 By default, backups include all subfolders containing generated compose files. These subfolders are created automatically every time a compose file is generated via the GUI. By default, backups include all subfolders containing generated compose files. These subfolders are created automatically every time a compose file is generated via the GUI.
  
Line 1215: Line 1248:
 === Create === === Create ===
  
-{{ :omv7:omv7_plugins:compose9.jpg?direct&400|Schedule}}+{{ :omv7:omv7_plugins:compose9.jpg?direct&600|Schedule}}
 Opens a dialog to schedule container backup and/or update jobs. Opens a dialog to schedule container backup and/or update jobs.
  
  • omv8/omv8_plugins/docker_compose.1766318281.txt.gz
  • Last modified: 2025/12/21 11:58
  • by chente