Docker with Windows

Open
#60 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
docker, docker-compose
Domain
documentation

Research direction

Start with the Docker instructions and the Docker Compose configuration described in the issue. Document that docker compose should be run inside a WSL instance for GUI support, and identify the two additional files and environment variable that must be configured. Done means the instructions cover Windows users and the required GUI mounts and setting.

Written by the indexing model from the issue text.

Description

We got some feedback from @mdox98 about using Docker/ROS on Windows with GUIs.

We should make a note on the Docker instructions to run docker compose inside a WSL instance, not using the Windows terminal. We think doesn't impact performance since we're not actually nesting Docker in WSL (WSL just accesses the Docker resources that live outside of WSL). However, doing it inside WSL gives Docker access to the wslg server to do X11/GUI stuff.

In the Docker compose, there are two additional files to mount and an env variable that you need to set in the compose file in order to get GUIs.

Dominant language
TeX
Stars
1
Forks
3
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rosflight/rosflight_docs

All issues in rosflight/rosflight_docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.