diff --git a/README.md b/README.md index de9c317..9789f8a 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,20 @@ Discord ──voice / video / slash──▶ bot/ (Node + bun, discord.js ## 요구 사항 -- Ubuntu 데스크톱 + TigerVNC(:1) — `docs/vnc-xfce-setup.md` -- Python 3.11+ (두뇌/브릿지), `ffmpeg` -- [bun](https://bun.sh) (디스코드 봇) -- Ollama (jarvis 두뇌의 LLM 백엔드) -- 디스코드 **봇** 토큰 1개 (음성/슬래시) -- (셀프봇 송출 사용 시) 디스코드 **버너 유저** 토큰 1개 +Docker로 돌리면(권장) 호스트에는 Docker + (GPU 쓸 경우) NVIDIA 드라이버만 있으면 되고, Python/bun/Ollama/ffmpeg/Whisper/Piper는 전부 컨테이너 안에 포함됩니다. + +OS별 호스트 준비물: + +| | Linux (Ubuntu 등) | Windows 11 | +|---|---|---| +| 컨테이너 런타임 | Docker Engine (CDI 지원, Docker 25+) | Docker Desktop + WSL2 백엔드 | +| GPU 가속(선택) | `nvidia-container-toolkit` + `nvidia-ctk cdi generate` | NVIDIA 드라이버 + Docker Desktop GPU(WSL2) 활성화 | +| GPU 넣는 compose | `docker-compose.gpu-linux.yml` | `docker-compose.gpu-windows.yml` | + +- 디스코드 **봇** 토큰 1개 (음성/슬래시) — 또는 (셀프봇 송출 사용 시) 디스코드 **버너 유저** 토큰 1개 +- (도커 없이 수동 실행 시에만) Python 3.11+, [bun](https://bun.sh), Ollama, `ffmpeg`를 호스트에 직접 설치 — 아래 "수동" 절 참고 + +> VNC 데스크톱 호스트를 직접 구성하는 경우(도커 미사용)는 `docs/vnc-xfce-setup.md` 참고. 도커 실행에서는 VNC+XFCE가 컨테이너 안에 이미 들어 있습니다. --- @@ -51,11 +59,31 @@ Discord ──voice / video / slash──▶ bot/ (Node + bun, discord.js 환경 설정 없이 통째로 컨테이너에서 돌립니다. VNC 데스크톱 + 크롬 + Python 브릿지 + Node 봇이 한 컨테이너(`javis`)에, LLM 백엔드(Ollama)가 별도 컨테이너에 뜹니다. **올리기만 하면 Ollama 모델까지 자동으로** 받아집니다. +베이스 `docker-compose.yml`에는 GPU 설정이 없습니다(이식성 유지). GPU는 OS에 맞는 override 파일을 같이 얹어서 켭니다. **돌리는 OS에 따라 명령이 다릅니다:** + ```bash -# 빌드 & 기동 — 이게 전부입니다. +# ── Linux (Ubuntu 등, nvidia-container-toolkit + CDI) ── +docker compose -f docker-compose.yml -f docker-compose.gpu-linux.yml up -d --build + +# ── Windows 11 (Docker Desktop + WSL2 + NVIDIA) ── +docker compose -f docker-compose.yml -f docker-compose.gpu-windows.yml up -d --build + +# ── GPU 없이 (CPU 전용 호스트) ── +# .env 에 WHISPER_DEVICE=cpu, MELO_DEVICE=cpu 를 넣고 베이스만 사용 docker compose up -d --build ``` +매번 `-f`를 치기 싫으면 `.env`에 한 줄 넣어두면 그냥 `docker compose up -d`로 됩니다(override가 자동 적용): + +```bash +# Linux +COMPOSE_FILE=docker-compose.yml:docker-compose.gpu-linux.yml +# Windows 11 +COMPOSE_FILE=docker-compose.yml:docker-compose.gpu-windows.yml +``` + +> Linux와 Windows는 GPU를 컨테이너에 넣는 방식이 달라서 override 파일이 갈립니다. Linux는 CDI(`devices: nvidia.com/gpu=all`), Windows(Docker Desktop)는 Compose의 `deploy.resources.reservations.devices`(`driver: nvidia`)를 씁니다. 호스트 사전 준비는 아래 "GPU 가속" 절 참고. + `docker compose up` 한 번이면 자동으로: - Ollama 서버가 뜨고, `ollama-init`이 채팅/임베딩 모델을 **자동 pull** - VNC+XFCE 데스크톱 + 크롬 + Python 브릿지가 기동 @@ -81,23 +109,33 @@ docker compose up -d # 유저봇이 로그인해 지정 음성채널에 일반 봇(슬래시 명령 `/자비스`)으로 돌리려면 `DISCORD_BOT_TOKEN` / `DISCORD_APP_ID` / `DISCORD_GUILD_ID`를 채우세요. 다만 일반 봇은 화면 송출(Go Live)을 할 수 없습니다. `DISCORD_BOT_TOKEN`이 비어 있고 `DISCORD_SELFBOT_TOKEN`이 있으면 자동으로 유저봇 모드로 동작합니다. (`OLLAMA_CHAT_MODEL` 등 모델을 바꾸려면 `.env`에서 지정 후 `docker compose up -d`.) -### GPU 가속 (기본 ON) +### GPU 가속 (OS별) -LLM(Ollama)과 Whisper STT가 **기본적으로 GPU(RTX 5050, Blackwell sm_120)** 에서 돕니다. 검증 완료: Ollama 100% GPU 오프로드, faster-whisper float16 GPU 동작. +LLM(Ollama), Whisper STT, MeloTTS가 GPU에서 돕니다(env 기본 `WHISPER_DEVICE=cuda`, `MELO_DEVICE=cuda`). NVIDIA Blackwell(sm_120, 예: RTX 5050/5070Ti)에서 검증: 컨테이너 내 torch cu128 CUDA 동작, Ollama GPU 오프로드, faster-whisper float16, MeloTTS GPU 합성 모두 확인. -호스트 사전 준비(1회): +GPU는 위 "실행 — Docker"의 OS별 override 파일로 켜집니다. 호스트 사전 준비는 OS마다 다릅니다: + +**Linux (Ubuntu 등) — CDI 방식, 1회:** ```bash -# nvidia-container-toolkit 설치 후 CDI 스펙 생성 (Docker 29 CDI 방식, 데몬 재시작 불필요) +# nvidia-container-toolkit 설치 후 CDI 스펙 생성 (Docker 25+ CDI, 데몬 재시작 불필요) sudo nvidia-ctk cdi generate --output=/etc/cdi/nvidia.yaml docker run --rm --device nvidia.com/gpu=all ubuntu nvidia-smi -L # GPU 보이면 OK ``` -`docker-compose.yml`은 두 컨테이너에 `devices: ["nvidia.com/gpu=all"]`(CDI)로 GPU를 넣습니다. +`docker-compose.gpu-linux.yml`이 두 컨테이너에 `devices: ["nvidia.com/gpu=all"]`(CDI)로 GPU를 넣습니다. -- 모델: 기본 `qwen3:8b` — 8GB VRAM에서 도구호출(tool calling)이 가장 안정적이고 ~5GB(Q4)로 잘 맞습니다. 더 가볍게/무겁게 쓰려면 `.env`의 `OLLAMA_CHAT_MODEL` 변경. -- Whisper는 `WHISPER_DEVICE=cuda`/`float16` 기본. **GPU가 없으면 자동으로 CPU로 폴백**하므로 안전합니다. -- GPU가 아예 없는 호스트라면 `docker-compose.yml`의 두 `devices:` 블록을 지우고 `.env`에 `WHISPER_DEVICE=cpu`를 두면 됩니다. +**Windows 11 — Docker Desktop + WSL2:** + +- 최신 NVIDIA 게임/스튜디오 드라이버 설치(별도 CUDA 툴킷 불필요). +- Docker Desktop → Settings → Resources → WSL Integration 활성화(WSL2 백엔드). 최신 Docker Desktop은 WSL2에서 GPU를 자동 노출합니다. +- 확인: PowerShell에서 `docker run --rm --gpus all nvidia/cuda:12.4.0-base-ubuntu22.04 nvidia-smi`. +- `docker-compose.gpu-windows.yml`이 `deploy.resources.reservations.devices`(`driver: nvidia`, `count: all`)로 GPU를 넣습니다. + +**공통:** + +- 모델: 베이스 compose 기본은 `qwen2.5:3b`(8GB VRAM에서 도구호출 안정적). 더 무겁게(`qwen2.5:7b`, `qwen3:8b` 등) 쓰려면 `.env`의 `OLLAMA_CHAT_MODEL` 변경. +- **GPU가 없거나 인식 실패 시 자동으로 CPU 폴백**(Whisper)하므로 안전합니다. 명시적으로 CPU만 쓰려면 override 파일 없이 베이스만 올리고 `.env`에 `WHISPER_DEVICE=cpu`, `MELO_DEVICE=cpu`를 두세요. - 데이터(메모리 DB), Whisper 캐시, Piper 음성은 named volume에 영속됩니다. - 셀프봇 영상 송출 의존성은 이미지에 기본 포함하지 않습니다. 쓰려면 컨테이너에서 `cd /app/bot && bun add discord.js-selfbot-v13 @dank074/discord-video-stream` 후 재시작(또는 Dockerfile에 추가). @@ -106,14 +144,17 @@ docker run --rm --device nvidia.com/gpu=all ubuntu nvidia-smi -L # GPU 보이 ## 실행 — 수동(도커 없이) +도커 없이 호스트에서 직접 돌릴 때는 OS별로 venv 활성화·ffmpeg 설치·실행 스크립트가 다릅니다. + +**Linux / macOS:** + ```bash # 1) 환경 변수 -cp .env.example .env -# DISCORD_BOT_TOKEN / DISCORD_APP_ID / DISCORD_GUILD_ID 등 채우기 +cp .env.example .env # DISCORD_BOT_TOKEN / DISCORD_APP_ID / DISCORD_GUILD_ID 등 채우기 # 2) Python 두뇌 + 브릿지 의존성 -python -m venv .venv && . .venv/bin/activate -pip install -r requirements.txt # jarvis 두뇌 +python3 -m venv .venv && . .venv/bin/activate +pip install -r requirements.txt # jarvis 두뇌 pip install flask # 브릿지(없으면) # 3) 디스코드 봇 의존성 (bun) @@ -121,11 +162,34 @@ cd bot && bun install && cd .. # 4) 한 번에 실행 (브릿지 + 봇) ./scripts/dev.sh -# 또는 따로: -# ./scripts/start_bridge.sh -# ./scripts/start_bot.sh +# 또는 따로: ./scripts/start_bridge.sh / ./scripts/start_bot.sh ``` +- `ffmpeg`: Ubuntu `sudo apt install ffmpeg`, macOS `brew install ffmpeg`. + +**Windows 11 (PowerShell):** + +```powershell +# 1) 환경 변수 +copy .env.example .env # 같은 키들 채우기 + +# 2) Python 두뇌 + 브릿지 의존성 (venv 활성화 경로가 다름) +py -3 -m venv .venv; .\.venv\Scripts\Activate.ps1 +pip install -r requirements.txt +pip install flask + +# 3) 디스코드 봇 의존성 (bun — Windows 네이티브 또는 WSL2) +cd bot; bun install; cd .. + +# 4) 실행: .sh 스크립트는 bash 전용이라 Windows에서는 두 프로세스를 따로 띄웁니다 +# (PowerShell 창 2개, 또는 WSL2에서 위 Linux 절차 그대로 사용 권장) +python -m bridge.server # 창 1: 브릿지 +cd bot; bun run register; bun run start # 창 2: (일반 봇이면) 슬래시 등록 후 봇 기동 +``` + +- `ffmpeg`: `winget install Gyan.FFmpeg` 또는 `choco install ffmpeg` 후 PATH 확인. +- `scripts/*.sh`(dev/start_bridge/start_bot)는 bash 스크립트라 순수 Windows에선 동작하지 않습니다. 가장 간단한 길은 **WSL2 안에서 위 Linux 절차를 그대로** 쓰는 것입니다(도커도 WSL2 백엔드와 동일). + 봇이 뜨면 디스코드에서 `/자비스 join` 으로 음성 채널에 부르세요. --- @@ -177,7 +241,10 @@ cd bot && bun install && cd .. - `BRIDGE_URL` — 봇이 호출할 브릿지 주소 (기본 `http://127.0.0.1:8765`) - `STREAM_BACKEND`, `DISCORD_SELFBOT_TOKEN`, `NOVNC_URL` — 화면 송출 - `VNC_DISPLAY=:1`, `VNC_RESOLUTION`, `VNC_FRAMERATE`, `VNC_BITRATE_KBPS` — 캡처 -- `WHISPER_DEVICE/COMPUTE_TYPE` — RTX 5050이면 `cuda`/`float16` 권장 +- `WHISPER_DEVICE/COMPUTE_TYPE`, `MELO_DEVICE` — GPU 호스트면 `cuda`/`float16`, CPU 전용이면 `cpu`(GPU 자체는 OS별 override compose 파일로 켬) +- `OLLAMA_CHAT_MODEL` — 두뇌 LLM (기본 `qwen2.5:3b`) +- `COMPOSE_FILE` — OS별 GPU override를 매번 `-f`로 안 치고 자동 적용 (위 "실행 — Docker" 참고) +- `output_language` — 출력 언어 고정(비우면 사용자 언어). 설정 웹 UI(`/settings`)에서 바꾸면 env 기본값보다 우선하며 컨테이너 재생성 후에도 유지됩니다. ---