Packed with:
VSCode and devcontainer running on Mac:
WebIDE opened from the local browser while devcontainer is running on the remote server:
You can run preconfigured simulation environment as a docker sidecar container.
Enter following command to select the simulator:
$ ./select-simulator.sh
Preconfigured simulation environment currently includes: Flatland, TurtleBot3, ARIAC, Virtual RobotX, UUV.
See the following index for list of current simulators:
https://github.com/devrt/simulator-index/blob/master/index.yaml
If you want any other simulator, let us know by submitting the issue:
https://github.com/devrt/simulator-index/issues
As of writing, docker-compose support of VSCode is not so stable on all the platforms. We recommend using code-server WebIDE since it has complete VSCode function support.
Clone this repository:
$ git clone https://github.com/devrt/ros-devcontainer-vscode.git
Enter the following command under the folder of the cloned project:
$ cd ros-devcontainer-vscode
$ docker-compose up
Open http://localhost:3001/ using your favorite browser.
You can also use remote server to host the devcontainer (run docker-compose up
on the remote server and open http://[remote-server]:3001
).
First, you have to install VSCode and Docker for Windows/Mac:
After you installed required softwares:
For detailed instructions, see: https://code.visualstudio.com/docs/remote/containers
Please apply following two settings, if you are using your PC behind the proxy.
Click Docker Desktop task bar icon > Select preference
menu item. You will see the following options:
In most cases, System proxy
option will work. But if you have problem downloading the docker images, please try Manual proxy configuration
option.
This setting will enable you to use the apt-get
or the other network commands inside the devcontainer.
First, open .env.sample
file under the root folder of the cloned project.
Edit the settings according to your environment.
Save the file as name .env
.
Next, open docker-compose.yml
file under the root folder of the cloned project and uncomment the following lines:
workspace:
env_file:
- .env
If you want to reset the devcontainer. Please close vscode and enter the following command under the folder of the cloned project:
$ docker-compose down
If you want to update the environment to the most recent version. Please enter the following commands under the folder of the cloned project:
$ git pull origin master
$ docker-compose pull
Please be noticed that the docker-compose down
command will reset your environment including installed .deb
packages. However, if you write package.xml
files correctly, you can reinstall all the depending packages by entering the following two commands:
$ rosdep update
$ rosdep install --from-paths src --ignore-src -r -y
If you are using Docker Toolbox, open the following URL instead:
If you want browser screen to be integrated with VS Code, use Browser Preview for VS Code extension.
Yosuke Matsusaka (MID Academic Promotions, Inc.)
Code in this repository (Dockerfile, utility scripts, etc) is distributed under Apache 2.0 license.
Included components are distributed under each different licenses: