omv7:docker_in_omv

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:docker_in_omv [2024/09/07 15:18] – [2. Plugin Settings] chenteomv7:docker_in_omv [2025/01/09 15:53] (current) – [2. Plugin Settings] chente
Line 152: Line 152:
 Done. We now have a user //jellyfin// with a primary group //jellyfin// that we can assign to the jellyfin container and we can guarantee that it will only have access to the folders we give it permission to. The //jellyfin// user will not be able to access any other folder on the system since it does not belong to the //users// group. Additionally, the persistent data in the jellyfin container will belong to the //jellyfin// user and the //jellyfin// group, so no other container will be able to access those files either. If we want another user to have access to that persistent data we just have to include it in the //jellyfin// group. Now we have that container perfectly isolated. Done. We now have a user //jellyfin// with a primary group //jellyfin// that we can assign to the jellyfin container and we can guarantee that it will only have access to the folders we give it permission to. The //jellyfin// user will not be able to access any other folder on the system since it does not belong to the //users// group. Additionally, the persistent data in the jellyfin container will belong to the //jellyfin// user and the //jellyfin// group, so no other container will be able to access those files either. If we want another user to have access to that persistent data we just have to include it in the //jellyfin// group. Now we have that container perfectly isolated.
  
-**In this document we will use a single user called //appuser// and created in the GUI for simplicity, this is enough for many users. Consider your use case and whether or not you need to go further.**+**In this document we will use a single user called //appuser// and created in the GUI, this is more than enough for 99% of users. Consider your use case and whether or not you need to go further. If you do, act accordingly throughout the entire process.**
  
 ---- ----
Line 180: Line 180:
  
 The first step is to define some folders where the different data is stored. To do this, we go to the SERVICES > COMPOSE > SETTINGS tab. The first step is to define some folders where the different data is stored. To do this, we go to the SERVICES > COMPOSE > SETTINGS tab.
 +There are many possible configurations on a NAS. First we will see a simple configuration and then we will see a somewhat more advanced configuration.
 +
 +----
 +
 +== 2.1  SIMPLE OMV NAS SYSTEM ==
 +
 +In the simple configuration we have the OMV operating system on a pendrive. We also have a drive that stores all the NAS data. In this unit we will configure docker and everything necessary.
 +
 +The following image shows a schematic of this type of configuration.
 +
 +{{ :omv7:dockeromv7-28.jpg?direct&1200 |Expand image -> Docker folders - Simple NAS}}
 +
 +In this case all the necessary folders are on the same drive so everything will be very simple. All of them will be inside the mount folder of that drive, something like ''/srv/dev-disk-by-uuid.../appdata'' for example.
 +
 +Create those shared folders in the OMV GUI and follow the explanations in point 2.3. Just keep in mind that all paths in this case will be in the same mount folder of type ''/srv/disk-by-uuid-.../docker'' or ''/srv/disk-by-uuid-.../backup_compose'' since there is only one unit.
 +
 +----
 +
 +== 2.2 ADVANCED OMV NAS SYSTEM ==
 +
 +In a more advanced configuration than the previous one we can find something like the following.
  
 The image below shows an example schematic that may be typical of any OMV NAS. The explanations in this document from now on will be based on this example system. Your system will probably be different, adapt the explanations to your real system. The image below shows an example schematic that may be typical of any OMV NAS. The explanations in this document from now on will be based on this example system. Your system will probably be different, adapt the explanations to your real system.
Line 198: Line 219:
  
 On the right you can see how the plugin's SETTINGS tab could be configured following this diagram. If your system is simpler or more complicated, adapt it accordingly. A simpler system could be one drive for OMV and another drive for data, in which case just create all the necessary folders on the data drive. On the right you can see how the plugin's SETTINGS tab could be configured following this diagram. If your system is simpler or more complicated, adapt it accordingly. A simpler system could be one drive for OMV and another drive for data, in which case just create all the necessary folders on the data drive.
-{{ :omv7:dockeromv7-6.png?direct&1400 |Expand image -> Docker folders}}+{{ :omv7:dockeromv7-6.png?direct&1400 |Expand image -> Docker folders - Typical NAS}} 
 + 
 +---- 
 + 
 +== 2.3  CONFIGURATION ==
  
 In any case, the main recommendation here is to **keep docker data and the OMV operating system separate**. In any case, the main recommendation here is to **keep docker data and the OMV operating system separate**.
Line 210: Line 235:
 - Installing OMV on a USB flash drive is a good idea. But installing docker also on that pendrive is detrimental to the pendrive because docker will perform continuous writes, penalizing the longevity of the pendrive despite openmediavault-flashmemory.<br> - Installing OMV on a USB flash drive is a good idea. But installing docker also on that pendrive is detrimental to the pendrive because docker will perform continuous writes, penalizing the longevity of the pendrive despite openmediavault-flashmemory.<br>
 - If you don't have a fast drive you can install docker on one of the data drives. The applications won't go as fast but at least they will be separated from rootfs. - If you don't have a fast drive you can install docker on one of the data drives. The applications won't go as fast but at least they will be separated from rootfs.
 +</tr></table></body></html>
 +
 +<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; Beginners Info
 +</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
 +<b>Capacity of the disk drive dedicated to docker</b><br>
 +This capacity depends on the number and type of containers you are going to configure. A minimum of 60GB or 100GB would be recommended.
 +If you are going to use database containers like Jellyfin or Plex with very large libraries you may need more, perhaps 250GB or 500GB. Nextcloud can also take up a lot of space depending on how you use it.<br>
 </tr></table></body></html> </tr></table></body></html>
  
Line 274: Line 306:
 </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;">
 If you don't have a fast drive for Docker, you can configure the <i>data</i> and <i>appdata</i> folders in the same shared folder. This will make the CHANGE_TO_COMPOSE_DATA_PATH variable serve to define the path of both. This is how the plugin example files are preconfigured. If you don't have a fast drive for Docker, you can configure the <i>data</i> and <i>appdata</i> folders in the same shared folder. This will make the CHANGE_TO_COMPOSE_DATA_PATH variable serve to define the path of both. This is how the plugin example files are preconfigured.
 +</tr></table></body></html>
 +    * ...<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; Beginners Info
 +</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
 +The internal structure described in the "data" folder is unimportant. In this document, a "standard" structure has simply been described for illustrative purposes, so that the reader has a general idea about what the content of that folder may be. You can distribute within that folder any directory tree that you feel comfortable with.
 </tr></table></body></html> </tr></table></body></html>
   * CONFIGURE THE DATA FOLDER:   * CONFIGURE THE DATA FOLDER:
Line 318: Line 354:
     *...<html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#2C6700;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Advanced configuration.     *...<html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#2C6700;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Advanced configuration.
 </span></strong></td></tr><tr><td style="background-color:#e7fae1;height:25px;width:380px;"> </span></strong></td></tr><tr><td style="background-color:#e7fae1;height:25px;width:380px;">
-You can <b>customize the /etc/docker/daemon.json file</b> manually to customize the options. It is useful to set the driver for an nvidia card or for the driver for a different file system.<br>+You can <b>customize the /etc/docker/daemon.json file</b> manually to customize the options. Doing this is useful for setting the driver for an nvidia card or for the driver for a different file system.<br>
 If you need to customize this file just leave the Docker storage field blank, the plugin will not modify the file. If you need to customize this file just leave the Docker storage field blank, the plugin will not modify the file.
 </tr></table></body></html> </tr></table></body></html>
Line 395: Line 431:
 # In this file you can define how many paths you need for different compose files. # In this file you can define how many paths you need for different compose files.
 # The following are examples corresponding to the example system in the Docker on OMV document on the omv-extras wiki. # The following are examples corresponding to the example system in the Docker on OMV document on the omv-extras wiki.
 +# Customize the values ​​according to your system configuration.
 # #
 PATH_TO_APPDATA=/srv/dev-disk-by-uuid-9d43cda9-20e5-474f-b38b-6b2b6c03211a/appdata PATH_TO_APPDATA=/srv/dev-disk-by-uuid-9d43cda9-20e5-474f-b38b-6b2b6c03211a/appdata
Line 467: Line 504:
     * TZ -> You can see your local configuration in SYSTEM > DATE & TIME and in TIME ZONE field.     * TZ -> You can see your local configuration in SYSTEM > DATE & TIME and in TIME ZONE field.
     * APPDATA -> Find the absolute path of your //appdata// shared folder in STORAGE > SHARED FOLDERS in the ABSOLUTE PATH column. Copy by clicking the link and paste it here.     * APPDATA -> Find the absolute path of your //appdata// shared folder in STORAGE > SHARED FOLDERS in the ABSOLUTE PATH column. Copy by clicking the link and paste it here.
-    * If you need to define other different paths you can also do it here in the same way as the rest of the variables.+    * Customize the values ​​of all paths according to your system configuration. If you need to define other different paths you can also do it here in the same way as the rest of the variables. 
 +    * You can define other variables according to your needs, such as database passwords or any value your compose file needs.
  
 ---- ----
Line 744: Line 782:
     * To open a code box press the **''</>''** button in the toolbar of the box in which you write the post.     * To open a code box press the **''</>''** button in the toolbar of the box in which you write the post.
     * Copy and paste the code inside.     * Copy and paste the code inside.
-    * Hide sensitive data, such as passwords or email addresses. +    * Hide sensitive data, such as passwords or email addresses or web domains. 
-    * Be grateful for help when you get it, keep in mind that all forum members are volunteers, even the OMV developers.+    * Be grateful for help when you receive it, keep in mind that all forum members are volunteers, including OMV and omv-extras developers.
  
 ---- ----
  • omv7/docker_in_omv.1725722281.txt.gz
  • Last modified: 2024/09/07 15:18
  • by chente