Skip to content

docs: Update README - Add Rancher/Docker Conflict Resolution and Port Troubleshooting Guide#1

Open
hankyo-sorohan wants to merge 3 commits into
mainfrom
chore/readme-troubleshooting
Open

docs: Update README - Add Rancher/Docker Conflict Resolution and Port Troubleshooting Guide#1
hankyo-sorohan wants to merge 3 commits into
mainfrom
chore/readme-troubleshooting

Conversation

@hankyo-sorohan
Copy link
Copy Markdown
Collaborator

@hankyo-sorohan hankyo-sorohan commented Apr 16, 2026

Summary

Updated the README.md to include commonly overlooked setup requirements and troubleshooting guidance for Docker Compose environment configuration.

Detailed Changes

Prerequisites

  • Added Git installation guide (winget, brew)
  • Emphasized that after installing Rancher Desktop, the container runtime must be set to dockerd (moby)
  • Added a note to prevent Quick Start confusion:
    Docker/Rancher Desktop must be running before executing docker compose up

Windows / Rancher Integration Troubleshooting

  • Added guidance and recommendations for resolving CLI conflicts and port occupation issues when Docker Desktop and Rancher Desktop are installed simultaneously
  • Added troubleshooting steps for resolving broken Windows host (WSL) port forwarding issues (netsh cleanup guide)

Verification

  • Verified Markdown formatting and content rendering

@hankyo-sorohan hankyo-sorohan changed the title docs: add troubleshooting for exec format error and Windows port conf… docs: README 업데이트 - Rancher 및 Docker 충돌 해소 및 포트 관련 트러블슈팅 가이드 추가 Apr 16, 2026
@hankyo-sorohan hankyo-sorohan force-pushed the chore/readme-troubleshooting branch 2 times, most recently from 84c352d to 0049af4 Compare April 16, 2026 01:17
@hankyo-sorohan hankyo-sorohan force-pushed the chore/readme-troubleshooting branch from 0049af4 to 7ed5873 Compare April 16, 2026 01:21
@hankyo-sorohan hankyo-sorohan changed the title docs: README 업데이트 - Rancher 및 Docker 충돌 해소 및 포트 관련 트러블슈팅 가이드 추가 docs: Update README - Add Rancher/Docker Conflict Resolution and Port Troubleshooting Guide May 18, 2026
Copy link
Copy Markdown
Contributor

@bumsu-choi-dr bumsu-choi-dr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README 문서 보강 잘 봤습니다. WSL exit code 1 / kubeconfig 심링크 수정과 오래된 netsh portproxy 정리는 실제로 자주 겪는 문제라 유용합니다. 머지 전 확인할 사항 몇 가지 남깁니다.

[수정 필요] simulator 포트 표에 1122이 잘못 기재됨

"Windows Port Conflicts" 표가 simulator의 호스트 포트로 1122을 명시했지만, docker-compose.ymlsimulator 서비스는 다음 4개만 노출합니다:

  • 12345:12345
  • 3601:3601
  • 502:502
  • 12360:12360/udp

1122은 compose 파일 어디에도 없습니다. 이대로 두면 가이드를 따르는 사용자가 존재할 수 없는 충돌을 쫓다가 1122 포트를 점유한 무관한 프로세스를 종료할 수 있습니다.

수정 제안: 표의 simulator 행과 Step 1의 netstat ... Select-String 패턴 양쪽에서 1122을 제거.

(build-module-fw 5022, build-module-ui 5023/3002/8089 은 compose와 일치 확인했습니다.)

[경미] Select-String 패턴이 부분 문자열을 매칭함

netstat -ano | Select-String "5023|3002|8089|5022|1122|12345|12360|3601|:502 "

Select-String은 앵커 없는 정규식이라 300213002/30021 등도 매칭해 오탐이 날 수 있습니다. :502 처럼 콜론·공백으로 감싸거나 :5023\b 같은 앵커를 쓰면 정확해집니다.

[경미] 코드 블록 언어 태그 불일치

wsl -d Ubuntu -- mv ..., docker context use default 등 Windows에서 PowerShell로 실행되는 명령이 shell 로 태그되어 있습니다. 인접한 powershell 블록과 통일하면 좋겠습니다. 무해한 수준이라 선택 사항입니다.


1122 한 가지만 수정하면 머지해도 좋다고 봅니다. 나머지 둘은 선택적 다듬기입니다.

- Remove non-existent port 1122 from simulator host ports table
  (docker-compose.yml exposes only 12345, 3601, 502, 12360/udp)
- Anchor Select-String regex with ':port\b' to avoid substring matches
  (e.g. previously 3002 also matched 13002, 30021)
- Unify code block language tags to 'powershell' for Windows-only blocks
  (wsl, netsh, docker context use default)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hankyo-sorohan
Copy link
Copy Markdown
Collaborator Author

hankyo-sorohan commented May 18, 2026

@bumsu-choi-dr Thanks for the review. All three items have been addressed (959527c).

  • [Required] Removed 1122: Dropped from both the simulator port table and the Select-String pattern. Only the ports actually exposed by the simulator service in docker-compose.yml remain: 12345 / 3601 / 502 / 12360(udp).
  • [Minor] Select-String anchors: Added :port\b anchors to every port so that values like 3002 no longer match unrelated ports such as 13002 or 30021.
  • [Minor] Code block tags: Unified ```shell blocks under the Windows troubleshooting section (docker context use default, wsl ..., netsh ..., and the Step 3 docker compose ... block) with the adjacent ```powershell blocks.

Please take another look when you get a chance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants