Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| omv6:omv6_plugins:docker_compose [2023/12/22 15:59] – [Create] chente | omv6:omv6_plugins:docker_compose [2024/04/27 17:22] (current) – chente | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | {{indexmenu_n> | + | {{indexmenu_n> |
| \\ | \\ | ||
| + | |||
| + | < | ||
| + | < | ||
| + | < | ||
| + | |||
| < | < | ||
| Line 64: | Line 69: | ||
| {{ : | {{ : | ||
| \\ | \\ | ||
| + | * 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 72: | 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 " | * You can choose a shared folder if you have already created it or create it directly by pressing the " | ||
| - | * 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 **Save** button. | + | * Click the **Save** button |
| ---- | ---- | ||
| Line 82: | Line 88: | ||
| * 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. | ||
| + | * To define this folder do the following: | ||
| + | * 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. | ||
| + | * Click the **Save** button if you have already finished configuring the parameters in this tab. | ||
| ---- | ---- | ||
| Line 95: | Line 105: | ||
| * Volumes of type '': | * Volumes of type '': | ||
| * Typing ''# | * Typing ''# | ||
| + | * Click the **Save** button if you have already finished configuring the parameters in this tab. | ||
| ---- | ---- | ||
| Line 103: | Line 114: | ||
| * If you are using nvidia drivers in your docker containers (e.g. for Plex or Jellyfin hardware transcoding) you have to leave the path blank. If not, the nvidia driver settings are getting corrupted each time you reconfigure the OMV settings. You can see more details in the [[https:// | * If you are using nvidia drivers in your docker containers (e.g. for Plex or Jellyfin hardware transcoding) you have to leave the path blank. If not, the nvidia driver settings are getting corrupted each time you reconfigure the OMV settings. You can see more details in the [[https:// | ||
| - | * In the **Docker Storage** field define the path of the folder you want to use to install Docker. | + | * In the **Docker Storage** field define the path of the folder you want to use to install Docker |
| * Avoid using symlinks in this field. | * Avoid using symlinks in this field. | ||
| - | * Click **Reinstall Docker** button. Docker is now installed in the new path. | + | * Click **Reinstall Docker** button. |
| < | < | ||
| Line 610: | Line 621: | ||
| ---- | ---- | ||
| - | ===== Schedule ===== | + | ===== Schedule |
| {{ : | {{ : | ||
| Line 656: | Line 667: | ||
| * Backup: If enabled, a backup task will be executed. | * Backup: If enabled, a backup task will be executed. | ||
| * 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. | * 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 '' | + | * Prune: If enabled, prune all dangling images. It does not use a filter, so all existing dangling images will be removed. Will run the '' |
| * **Schedule** | * **Schedule** | ||
| * Schedule the time of execution using the date and time options. | * Schedule the time of execution using the date and time options. | ||
| Line 757: | 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. | ||