stf: post 수정. docker 사용법 추가

Author: gee6809

_posts/2024-05-24-stf.md

@@ -8,7 +8,9 @@ tags:
 - STF
 date: 2024-05-24 17:57 +0900
 ---
-이 글에서는 스마트폰과 스마트워치 등의 장치를 원격으로 디버깅할 수 있는 STF(Smartphone Test Farm)에 대해 소개합니다. STF를 이용하면 다양한 디바이스를 서버에 연결하여, 개발한 애플리케이션을 여러 디바이스 환경에서 쉽게 테스트할 수 있습니다. 1인 개발자로서, 브라우저를 통해 원격으로 핸드폰을 조작할 수 있다는게 가장 큰 장점인 것 같습니다.
+이 글에서는 스마트폰과 스마트워치 등의 장치를 원격으로 디버깅할 수 있는 STF(Smartphone Test Farm)에 대해 소개합니다. 
+
+STF를 이용하면 다양한 디바이스를 서버에 연결하여, 개발한 애플리케이션을 여러 디바이스 환경에서 쉽게 테스트할 수 있습니다. 
 
 공식 git 주소는 다음과 같습니다.  
 [https://github.com/DeviceFarmer/stf](https://github.com/DeviceFarmer/stf)
@@ -22,39 +24,63 @@ List of devices attached
 192.168.0.40:5555       device
 ```
 
-## 주요 기능
+![stf 화면](/assets/img/STF/stf.webp)
+<p class="image-caption">STF 메인 화면</p>
 
-### 운영 체제 지원
-- **안드로이드**: 2.3.3 (SDK 10)부터 12 (SDK 32)까지 지원
-- **Wear OS**: 5.1 지원 (5.0은 권한 문제로 지원하지 않음)
-- **기타**: Fire OS, CyanogenMod 등 안드로이드 기반 배포판 지원
+## Docker로 실행
+Dockerfile을 제공해주기 때문에, Docker 환경에 익숙한사람은 docker를 활용하면 아주 쉽게 세팅할 수 있습니다.
+> Docker가 익숙하지 않거나 로컬에서 바로 실행하고 싶다면 [설치 방법](#설치-방법)으로 바로 넘어가세요
+{: .prompt-info}
+
+```
+stf-docker/            # 프로젝트 루트
+├── docker-compose.yml # STF 서비스를 정의
+└── .env               # PUBLIC_IP 등 가변 환경변수
+```
 
-### 장치 제어
-- 브라우저에서 장치 원격 제어
-- 실시간 화면 보기 (최대 30-40 FPS)
-- 회전 지원
-- 키보드 입력 및 메타 키 지원
-- 드래그 앤 드롭을 통한 apk 파일 설치 및 실행
-- 장치 로그 실시간 보기 및 필터링
+```yaml
+# docker-compose.yml
+services:
+  rethinkdb:
+    image: rethinkdb:2.4
+    container_name: rethinkdb
+    network_mode: host
+    restart: unless-stopped
+  stf:
+    image: devicefarmer/stf:latest
+    container_name: stf
+    network_mode: host              # 호스트 네임스페이스 그대로 사용
+    volumes:
+      - ~/.android:/root/.android   # 호스트 ADB RSA 키 재사용
+    environment:
+      # STF 웹 UI·포트 포워딩에 표시될 호스트 주소
+      - PUBLIC_IP=${PUBLIC_IP:-127.0.0.1}
+    command: >
+      stf local
+        --public-ip ${PUBLIC_IP:-127.0.0.1}
+        --adb-host 127.0.0.1
+        --adb-port 5037
+        --provider-min-port 7400
+        --provider-max-port 7500
+        --no-cleanup
+        --allow-remote
+    restart: unless-stopped
+    depends_on:
+      - rethinkdb
+```
+```
+#.env
+PUBLIC_IP={나의 IP 주소} # (ex. 192.168.0.62) 호스트 → STF 접근 시 사용
+```
+위와 같이 설정하고 `docker compose up -d`를 하면 바로 smartfarm을 사용할 수 있습니다.
+host와 adb server를 공유하기 때문에, usb로 새로운 디바이스를 꽂으면 바로 인식됩니다.
 
-### 장치 관리
-- 연결된 장치 상태 모니터링 (사용 중, 오프라인, 인증되지 않음 등)
-- 장치 하드웨어 사양 표시
-- 배터리 상태 모니터링
+docker가 실행되면 바로 [브라우저로 접속](#브라우저로-접속하기)하시면 됩니다.
 
 ## 설치 방법
+Host에 직접 설치해서 실행할 수도 있습니다.
 
 ### 1. 필수 의존성 설치
-- Node.js (최대 20.x)
-- ADB
-- RethinkDB (>= 2.2)
-- CMake (>= 3.9)
-- GraphicsMagick
-- ZeroMQ 라이브러리
-- Protocol Buffers 라이브러리
-- yasm
-- pkg-config
-
 ```bash
 # Add the RethinkDB repository
 wget -qO- https://download.rethinkdb.com/repository/raw/pubkey.gpg | \
@@ -68,7 +94,7 @@ sudo apt-get update
 sudo apt-get install -y nodejs adb rethinkdb cmake graphicsmagick libzmq3-dev libprotobuf-dev yasm pkg-config npm
 ```
 
-만약 `apt update`중에 RethinkDB repository 때문에 error가 난다면 직접 빌드해서 사용할수도 있습니다.
+만약 `apt update`중에 RethinkDB repository 때문에 error가 난다면 직접 빌드해서 사용하면 됩니다.
 ```bash
 # Remove RethinkDB repository
 sudo rm /usr/share/keyrings/rethinkdb-archive-keyrings.gpg
@@ -97,28 +123,41 @@ rethinkdb
 ```bash
 stf local
 ```
-그 후 브라우저로 `http://localhost:7100` 접속하면 됩니다.  
-![STF 로그인 페이지](/assets/img/STF/login.webp)
-<p class="image-caption">STF 로그인 페이지</p>
-
-초기 관리자 계정은 다음과 같습니다. 
-> Name: administrator  
-> E-mail: [email protected]
 
 만약 localhost가 아닌 외부에서 접근하고 싶다면 다음과 같이 실행하면 됩니다.
+
 ```bash
+
 stf local --public-ip <your_internal_network_ip_here>
-# ex) stf local --public-ip 192.168.0.55  
+
+# ex) stf local --public-ip 192.168.0.55  
+
 # 브라우저로 http://192.168.0.55:7100 접속
+
 ```
 
+
 또한 usb가 아닌 wifi로 연결되어 있는 디바이스(`ex. adb connect 192.168.0.40:5555`)도 지원하려면 `--allow-remote`를 추가해야 합니다.
+
 ```bash
+
 stf local --allow-remote
+
 ```
-![stf 화면](/assets/img/STF/stf.webp)
-<p class="image-caption">STF 메인 화면</p>
+
+
+## 브라우저로 접속하기
+
+그 후 브라우저로 `http://localhost:7100` 접속하면 됩니다.  
+![STF 로그인 페이지](/assets/img/STF/login.webp)
+<p class="image-caption">STF 로그인 페이지</p>
+
+초기 관리자 계정은 다음과 같습니다. 
+> Name: administrator  
+> E-mail: [email protected]
+
 
 > 만약 접속이 안되거나 control 페이지에 디바이스 화면이 보이지 않는다면, 방화벽을 끄고 시도해보세요.
 {:.prompt-tip}
 
+