Skip to content

docs: revise Windows Docker build instructions - #7768

Merged
pfeerick merged 2 commits into
EdgeTX:mainfrom
shane-droid:patch-1
Sep 27, 2026
Merged

pfeerick merged 2 commits into
EdgeTX:mainfrom
shane-droid:patch-1

Conversation

@shane-droid

Copy link
Copy Markdown
Contributor

Updated the Windows Docker build instructions to include Windows 11, installation steps for Git and PowerShell, and clarified the build process for EdgeTX firmware, Companion, and Simulator.

Fixes #
build instructions for 2.12 and on

Summary of changes:

Updated the Windows Docker build instructions to include Windows 11, installation steps for Git and PowerShell, and clarified the build process for EdgeTX firmware, Companion, and Simulator.
@pfeerick pfeerick added the documentation 📝 Improvements or additions to documentation label Sep 11, 2026
@pfeerick pfeerick changed the title Revise Windows Docker build instructions docs: revise Windows Docker build instructions Sep 20, 2026
- Install Docker Engine inside WSL 2 (Ubuntu) as the main route, with
  Docker Desktop and Podman Desktop kept as alternatives.
- Use WSLg for Companion and Simulator instead of GWSL, with GWSL kept
  as a fallback.
- Start the container from tabs per runtime, passing
  CMAKE_BUILD_PARALLEL_LEVEL and -w /src, plus an etx-docker shell
  function to start it with a single command.
- Split the firmware build into configure and build steps, and drop
  the separate configure target and the in-source cmake -LAH.
- Point to tools/build-common.sh and CMake presets for radio options,
  and mention UF2 firmware for STM32H7 radios.
- Rework the Companion/Simulator sections, including a multi-radio
  example for 2.10 to 2.12 and matching build image tags for older
  releases.
- Add troubleshooting, tips for keeping Companion settings, and
  abbreviation definitions (enables the abbr extension in mkdocs.yml).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pfeerick
pfeerick merged commit 99b17f0 into EdgeTX:main Sep 27, 2026
3 checks passed
@pfeerick

pfeerick commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Thanks for working on this @shane-droid ... I've somewhat re-written most of the guide now, centered around using docker inside WSL so docker is only running when you need it, and because since this was originally written WSLg was not yet publicly available, and removes the need for GWSL, as well as makes it so both GUI and audio can be passed through. Both docker desktop and podman are mentioned as alternatives, as well as GWSL if needed for older versions of Windows 10. This is now live at https://edgetx.org/edgetx/latest/building/windows-docker/ so have a look through and if there is anything you think could be improved or you have any questions on, please let me know / do a follow up PR. :)

@pfeerick pfeerick added this to the 3.0 milestone Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📝 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants