How avery320/ros_docker_gui works
Project Type & Purpose
• This is a container-based ROS Noetic desktop environment with VNC and noVNC support.
• It provides one or more Docker Compose profiles (founROS, hiwin_dev) for different robotics development scenarios.
• Key use cases: GUI access to ROS workspace via browser or VNC client; development inside VSCode devcontainer.
File Structure
• Dockerfile & entrypoint.sh at project root define the base image (Ubuntu 20.04 + ROS Noetic + system tools + ROS packages).
• docker_compose/founROS and docker_compose/hiwin_dev each contain a docker-compose.yml and .devcontainer config, defining container services, ports, volumes, and devcontainer settings.
• README outlines ports (5901 VNC, 8080 noVNC), default credentials, workspace mount, and core packages.
README Insights
• The built image installs: tigervnc-server, supervisor, ROS desktop, industrial robot simulators, rviz, gazebo.
• Workspace is pre-configured at /home/ROS/workspace and mapped from local ./workspace.
• Provides browser-based noVNC client and supports VSCode “Reopen in Container.”
Main Components & Their Relationships
a. Host Machine
– Runs Docker Engine / Docker Compose
– Hosts local workspace directory (./workspace)
– Provides network endpoints (localhost:5901, localhost:8080)
b. Docker Image (“ros-desktop”)
– Base OS: Ubuntu 20.04
– System tools (supervisor, tini, git, curl, etc.)
– ROS Noetic desktop + industrial robot packages (Gazebo, RViz, MoveIt, etc.)
– VNC server (tigervnc) + noVNC web client
– Entrypoint script configures user, starts supervisor
c. Containers (per docker-compose profile)
– Service definitions for founROS or hiwin_dev
– Volume mount: host ./workspace → /home/ROS/workspace
– Port mappings: 5901/tcp (VNC), 8080/tcp (noVNC)
– Environment variables: ROS_DISTRO, USER, PASSWORD, VNC_PORT, NOVNC_PORT, etc.
d. In-Container Services (managed by supervisor)
– X11 desktop session
– VNC server process
– noVNC web server (HTTP)
– ROS core (roscore) and secondary ROS nodes (simulators, controllers)
e. External Clients
– VNC client (connects to host:5901)
– Web browser (HTTP to host:8080/vnc.html)
– VSCode remote container extension (connects via devcontainer.json)
Architectural Patterns & Design Principles
• “Single-container multi-service” pattern using supervisor to run VNC, ROS, and simulators in one container.
• Docker Compose for environment profiles—isolates founROS vs hiwin_dev setups.
• Volume mapping for persistent development workspace.
• Devcontainer integration for seamless IDE experience.