시놀로지 도커에 Dock나비-beta 설치하기

version: "3.8"

services:
  backend:
    image: sruinz/docknabi-backend:beta
    container_name: docknabi-backend
    restart: unless-stopped
    ports:
      - "8580:8080"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/app/data
      - /volume1/docker:/volume1/docker
      - /var/packages/ContainerManager/etc/projects:/var/packages/ContainerManager/etc/projects
    environment:
      - DATABASE_PATH=/app/data/docknabi.db
      - JWT_SECRET=${JWT_SECRET:-change-this-secret-in-production}
      - PORT=8080
      - BASE_PATH=/volume1/docker
    healthcheck:
      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:8080/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s

  frontend:
    image: sruinz/docknabi-frontend:beta
    container_name: docknabi-frontend
    restart: unless-stopped
    ports:
      - "8581:80"
    depends_on:
      - backend
    environment:
      - API_URL=http://backend:8080

networks:
  default:
    name: docknabi-network

/volume1/docker/docknabi/data

# 🦋 Docknabi 베타 버전 소개

> **버전**: Beta 0.0.0  
> **마지막 업데이트**: 2026-01-01

---

## 📋 목차

1. [서비스 개요](#서비스-개요)
2. [핵심 기능](#핵심-기능)
3. [주요 장점](#주요-장점)
4. [알려진 제한사항 및 단점](#알려진-제한사항-및-단점)
5. [지원 환경](#지원-환경)
6. [로드맵](#로드맵)

---

## 서비스 개요

**Docknabi(독나비)**는 Synology NAS와 Linux 서버를 위한 차세대 Docker 컨테이너 관리 플랫폼입니다.

기존 Docker 관리 도구들의 복잡성을 해소하고, 멀티 테넌시(Multi-Tenancy) 환경에서 여러 사용자가 안전하게 Docker 리소스를 공유할 수 있도록 설계되었습니다.

### 왜 Docknabi인가?

| 기존 문제점 | Docknabi 솔루션 |
|------------|----------------|
| 모든 사용자가 Docker에 무제한 접근 | 역할 기반 권한으로 리소스 접근 통제 |
| 리소스 쿼터 부재 | CPU, 메모리, 컨테이너 수, 스토리지 쿼터 |
| 복잡한 CLI 조작 필요 | 직관적인 웹 UI로 원클릭 관리 |
| 프록시 설정의 어려움 | NPM 연동 자동 프록시 요청/승인 시스템 |

---

## 핵심 기능

### 🐳 컨테이너 & 스택 관리

- **실시간 모니터링**: 컨테이너 상태, CPU/메모리 사용량 시각화
- **터미널 접속**: 웹 기반 xterm.js 터미널로 컨테이너 직접 접속
- **로그 스트리밍**: 실시간 로그 확인 및 검색
- **Docker Compose 편집**: Monaco Editor를 통한 YAML 편집 및 문법 강조

### 👥 멀티 테넌시 & 권한 관리

- **첫 가입자 = 슈퍼 관리자**: 하드코딩 없이 동적 권한 할당
- **3단계 역할 시스템**: Super Admin → Admin → User
- **세분화된 권한**: 스택 생성/수정/삭제, 컨테이너 관리, 프리셋 등록 개별 설정
- **리소스 쿼터**: 사용자별/역할별 CPU, 메모리, 컨테이너 수, 이미지/볼륨 스토리지 제한

### 🔌 NPM (Nginx Proxy Manager) 연동

- **프록시 요청 시스템**: 사용자가 도메인 → 컨테이너 프록시를 요청
- **관리자 승인 워크플로우**: 요청 → 검토 → 승인/거부 프로세스
- **자동 SSL 인증서**: Let's Encrypt 연동 자동 인증서 발급
- **토큰 자동 갱신**: NPM API 토큰 만료 시 자동 재발급

### 📚 프리셋 라이브러리

- **커뮤니티 템플릿**: 검증된 Docker Compose 템플릿 공유
- **카테고리 분류**: 미디어 서버, 개발 도구, 홈 자동화 등
- **원클릭 가져오기**: 프리셋 선택 → 자동 배포
- **.env 파일 지원**: 환경 변수 포함 프리셋 저장/불러오기

### 📂 파일 탐색기

- **FileStation 스타일 UI**: 익숙한 파일 관리 인터페이스
- **드래그 앤 드롭**: 파일 업로드/다운로드
- **압축/해제**: ZIP 파일 생성 및 해제
- **텍스트 편집**: Monaco Editor 기반 파일 편집

### 🔔 알림 시스템

- **실시간 알림**: 스택 배포, 컨테이너 상태, 프록시 승인 등
- **개인화 설정**: 알림 종류별 활성화/비활성화
- **관리자 시스템 알림**: 다른 사용자 활동 모니터링

---

## 주요 장점

### ✅ 직관적인 사용자 경험

- **글래스모피즘 다크 모드 UI**: 현대적이고 세련된 디자인
- **다국어 지원**: 한국어/영어 완벽 지원
- **반응형 레이아웃**: 데스크톱/태블릿 최적화

### ✅ 보안 및 격리

- **사용자별 폴더 격리**: `/docker/_users/{username}` 기반 데이터 분리
- **JWT 기반 인증**: 안전한 토큰 기반 인증
- **역할별 권한 강제**: 백엔드에서 모든 권한 검증

### ✅ Synology 최적화

- **Container Manager 연동**: 스택 자동 등록/해제
- **시놀로지 CPU 제한**: cpu_shares 기반 CPU 쿼터
- **DSM 7.x 호환**: 시놀로지 최신 OS 완벽 지원

### ✅ 운영 편의성

- **자동 마커 시스템**: Docknabi 관리 스택 vs 외부 스택 구분
- **외부 스택 가져오기**: 기존 Docker 스택을 Docknabi로 전환
- **볼륨 자동 생성**: Docker Compose 배포 시 필요 폴더 자동 생성

---

## 알려진 제한사항 및 단점

### ⚠️ 베타 버전 제한

| 항목 | 제한 사항 |
|------|----------|
| **안정성** | 일부 엣지 케이스에서 예기치 않은 동작 가능 |
| **백업 기능** | 내장 백업/복원 기능 미지원 (수동 DB 백업 필요) |
| **클러스터** | 단일 노드만 지원, Docker Swarm/K8s 미지원 |

### 🔶 기능적 제한

| 항목 | 제한 사항 |
|------|----------|
| **네트워크/볼륨 충돌** | Compose 파일 내 네트워크/볼륨 이름 충돌 자동 수정 미지원 |
| **이미지 빌드** | Dockerfile 빌드 미지원 (pull만 지원) |
| **컨테이너 로그 저장** | 로그 영구 저장/내보내기 미지원 |

### 🟡 환경 의존성

| 항목 | 요구 사항 |
|------|----------|
| **NPM 연동** | Nginx Proxy Manager 사전 설치 필요 |
| **Docker 소켓** | `/var/run/docker.sock` 마운트 필수 |
| **시놀로지 전용 기능** | Container Manager 연동은 DSM 7.x 전용 |

### 🔴 보안 고려사항

- **Docker 소켓 접근**: 백엔드가 Docker 소켓에 접근하므로 호스트 제어권 보유
- **내부 네트워크 전용**: 외부 네트워크 노출 시 리버스 프록시 + SSL 필수
- **비밀번호 해싱**: bcrypt 사용, 그러나 DB 암호화 미지원

---

## 지원 환경

### 하드웨어 요구사항

| 항목 | 최소 | 권장 |
|------|------|------|
| CPU | 2코어 | 4코어 이상 |
| RAM | 1GB | 4GB 이상 |
| 스토리지 | 100MB (앱) | 1GB+ (데이터) |

### 소프트웨어 요구사항

| 항목 | 버전 |
|------|------|
| Docker | 20.10+ |
| Docker Compose | v2.0+ |
| Synology DSM | 7.0+ (선택) |
| 브라우저 | Chrome/Firefox/Safari 최신 버전 |

### 기술 스택

| 구분 | 기술 |
|------|------|
| **백엔드** | Go 1.21+, Fiber, GORM, SQLite |
| **프론트엔드** | React 18+, TypeScript, Tailwind CSS, Zustand |
| **편집기** | Monaco Editor |
| **터미널** | xterm.js |

---

## 로드맵

### 🎯 v1.0 정식 릴리즈 (예정)

- [ ] 네트워크/볼륨 이름 충돌 자동 수정
- [ ] 사용자 데이터 백업/복원 기능
- [ ] 다중 NAS/서버 관리 (멀티 노드)
- [ ] 이미지 레지스트리 연동 (Docker Hub, GHCR)
- [ ] Webhook 알림 (Discord, Slack, Telegram)

### 🔮 장기 계획

- [ ] Kubernetes 지원
- [ ] 모바일 앱 (PWA)
- [ ] 플러그인 시스템
- [ ] AI 기반 Compose 파일 생성
- [ ] SSO 연동
- [ ] 텔레그램 봇, 디스코드 봇 내장 계획

---

## 피드백 및 버그 제보

베타 버전 테스트 중 발견된 버그나 개선 제안은 댓글을 통해 제보해 주세요.

> 🦋 **Docknabi** - 가볍고 자유로운 Docker 관리