search

osrf / icra2023_ros2_gz_tutorial

ICRA 2023 tutorial on ROS 2 and the new Gazebo (MT28, ICC Capital Suite 14)
Apache License 2.0
229 stars 33 forks source link

Update installation instructions for Docker #17

Closed AndrejOrsula closed 1 year ago

AndrejOrsula commented 1 year ago

This PR updates docker/README.md#Prerequisites to make the Docker installation instructions more explicit for participants regardless of their GPU, as discussed under #14.

It also adds a mention about configuring Docker for a non-root user because the current helper scripts (build.bash / run.bash / join.bash) require such setup and would fail otherwise. One of the troubleshooting sections of the same SubT wiki page is used as a reference.

Do you think that is enough? An alternative would be to update the scripts to run the docker ... commands with sudo if it would fail otherwise.

mabelzhang commented 1 year ago

Thank you so much for the additions!

Do you think that is enough? An alternative would be to update the scripts to run the docker ... commands with sudo if it would fail otherwise.

That might be helpful if people can't get it to work. Do you mind adding this to the Troubleshoot section at the bottom? Thanks!

Otherwise, this can go in as is too.

AndrejOrsula commented 1 year ago

An alternative would be to update the scripts to run the docker ... commands with sudo if it would fail otherwise.

For now I opened #21 to implement such alternative because I think it could simplify the setup. If it gets merged, then maybe the added paragraph about non-root user could even be removed?

Edit: This is the added paragraph I have in mind that could be removed:

+ While following the instructions, please add your user account to the docker
+ group in order to avoid permission issues by following the instructions under
+ the Troubleshooting section
+ [here](https://github.com/osrf/subt/wiki/Docker%20Install#troubleshooting).
mabelzhang commented 1 year ago

Ah I didn't click on that link previously. Let me comment on #21. Thanks!