docs: Add comments to Docker Compose files

2b-t · Sep 1, 2024 · bc88543 · bc88543
1 parent c97102e
commit bc88543
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/templates/ros/docker/docker-compose.yml b/templates/ros/docker/docker-compose.yml
@@ -17,8 +17,15 @@ services:
     extra_hosts:
       - "${ROBOT_HOSTNAME}:${ROBOT_IP}"
     image: ros_template:devel
+    # Required for communicating over the network
     network_mode: "host"
+    # Required for accessing hardware
+    #privileged: true
     tty: true
     volumes:
+      # Required for accessing hardware
+      #- /dev:/dev
+      # Required for accessing storage media
+      #- /media:/media
       - ../src:${CATKIN_WORKSPACE_DIR}/src
 
diff --git a/templates/ros2/docker/docker-compose.yml b/templates/ros2/docker/docker-compose.yml
@@ -20,9 +20,16 @@ services:
     extra_hosts:
       - "${ROBOT_HOSTNAME}:${ROBOT_IP}"
     image: ros2_template:devel
+    # Required for communicating over the network
     network_mode: "host"
+    # Required for accessing hardware
+    #privileged: true
     tty: true
     volumes:
+      # Required for accessing hardware
+      #- /dev:/dev
+      # Required for accessing storage media
+      #- /media:/media
       - ../src:${AMENT_WORKSPACE_DIR}/src
       - ../dds:${AMENT_WORKSPACE_DIR}/dds