devcontainer-cli-port-forwarder - GitLite

KO | EN

gitlite — search

#http #automation #claude #open-source #llm #claude-code #python #deep-learning #redis #cloud-native

devcontainer-cli-port-forwarder

(★ 13)

Enable Port Forwarding when using DevContainer CLI

파일 탐색기

ZIP 다운로드

forwarder.py
LICENSE
README.md

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

명령어 용어집

이 문서에서 사용된 명령어를 모아봤습니다. 낯선 명령어가 있다면 펼쳐서 확인해보세요.

🔍

`git clone`

설명 보기 ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

`socat`

설명 보기 ▼

다목적 릴레이(SOcket CAT).
더 많은 정보: <http://www.dest-unreach.org/socat/>.

sudo socat - TCP-LISTEN:8080,fork

포트를 수신 대기하고 연결을 기다리며 데이터를 표준 입력/출력으로 전송:

sudo socat OPENSSL-LISTEN:4433,reuseaddr,cert=./cert.pem,cafile=./ca.cert.pem,key=./key.pem,verify=0 STDOUT

SSL을 사용하여 포트를 수신 대기하고 표준 출력으로 출력:

sudo socat - TCP4:www.example.com:80

호스트와 포트에 연결을 생성하고 표준 입력/출력의 데이터를 연결된 호스트로 전송:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Overview
This Python script dynamically forward ports from a host machine to a Docker container according to `devcontainer.json` **forwardPorts**.

This Python script is created because currently DevContainer CLI does not support port forwarding, see [devcontainers/cli issue](https://github.com/devcontainers/cli/issues/22)

## Usage Context
- This script is only needed if you are managing your containers directly with the **devcontainer CLI**.
- If you are using vSCode with the Visual Studio Code Dev Containers extension,The VS Code extension already includes built-in support for port forwarding you do not need to use this script.

## Prerequisites
- host machine: Python 3 interpreter is installed.
- container: `socat` is installed.

## Features
- Dynamic Port Forwarding: Automates the process of forwarding specified ports from the host to a Docker container.
- Automatic Shutdown: The script automatically exits when the associated Docker container stops running.

# Installation
git clone this project under your project's `.devcontainer` directory, or anywhere you like.

```shell
git clone https://github.com/nohzafk/devcontainer-cli-port-forwarder.git .devcontainer/devcontainer-cli-port-forwarder
```

This script won't automatically install `socat` inside the container for you, you need to install `socat` inside the container.

you can simply add a line in **onCreateCommand** in your `devcontainer.json`

```json
"onCreateCommand": "sudo apt update && sudo apt install -y socat",
```

or use nix feature
```json
"features": {
    "ghcr.io/devcontainers/features/nix:1": {
        "packages": "socat"
    }
},
```

# Usage
In your **devcontainer.json**, set the `initializeCommand` to run the script in the background when the container is being initialized:

```json
"initializeCommand": "python3 .devcontainer/devcontainer-cli-port-forwarder/forwarder.py &",
```

To enable verbose output, which provides more detailed information about the port forwarding process, modify the initializeCommand as follows:
```json
"initializeCommand": "python3 .devcontainer/devcontainer-cli-port-forwarder/forwarder.py verbose &",
```

and finally specify the ports that you want to forward from host by **forwardPorts**,

for example port 2222 used by devcontainer feature sshd `"ghcr.io/devcontainers/features/sshd:1": {},`

Use 'forwardPorts' to make a list of ports inside the container available locally.
```json
"forwardPorts": [2222],
```

Once configured in your devcontainer.json, the script will automatically start when you create a devcontainer using the devcontainer CLI. It listens on specified ports and forwards them to the Docker container.

- The script runs in the background and does not require manual intervention once started.
- When the Docker container stops, the script detects this and exits automatically, ensuring that resources are not left unnecessarily consumed on the host machine.