Skip to content

UPLOAD-GUIDE.md

Latest commit

 

History

History
182 lines (139 loc) · 5.15 KB

UPLOAD-GUIDE.md

File metadata and controls

182 lines (139 loc) · 5.15 KB

Unraid 템플릿 추가 가이드

📋 준비된 파일들

다음 파일들을 mesh-router 저장소의 /unraid/ 폴더에 추가하면 됩니다:

mesh-router/
└── unraid/
    ├── nsl-router.xml          # ✅ 준비 완료
    ├── ca_profile.xml          # ✅ 준비 완료
    ├── README.md               # ✅ 준비 완료
    └── images/
        ├── nsl-router.png      # ⚠️ 이미지 필요
        └── yundera-logo.png    # ⚠️ 이미지 필요

🚀 GitHub에 추가하는 방법

방법 1: GitHub 웹 인터페이스 (간단)

  1. mesh-router 저장소로 이동

    https://github.com/Yundera/mesh-router

  2. unraid 폴더 생성

    • "Add file" → "Create new file" 클릭
    • 파일명에 unraid/README.md 입력
    • README.md 내용 붙여넣기
    • "Commit new file" 클릭

  3. 나머지 파일 업로드

    • unraid 폴더로 이동
    • "Add file" → "Upload files" 클릭
    • nsl-router.xml, ca_profile.xml 드래그
    • "Commit changes" 클릭

  4. images 폴더 생성 및 이미지 업로드

    • unraid 폴더에서 "Add file" → "Create new file"
    • 파일명에 images/.gitkeep 입력 (빈 폴더 유지용)
    • Commit
    • unraid/images/ 폴더로 이동
    • "Upload files"로 이미지 업로드

방법 2: Git 명령어 (로컬 작업)

# mesh-router 저장소 클론
cd /path/to/your/workspace
git clone https://github.com/Yundera/mesh-router.git
cd mesh-router

# unraid 폴더 및 파일 추가
mkdir -p unraid/images

# 파일들 복사 (준비된 파일들을 여기로 복사)
cp /path/to/nsl-router.xml unraid/
cp /path/to/ca_profile.xml unraid/
cp /path/to/README.md unraid/

# 이미지 파일 추가 (준비되면)
# cp /path/to/nsl-router.png unraid/images/
# cp /path/to/yundera-logo.png unraid/images/

# Git에 추가
git add unraid/
git commit -m "Add Unraid Community Applications template for NSL Router

- Add nsl-router.xml: Full Unraid template for mesh-router
- Add ca_profile.xml: Yundera developer profile
- Add README.md: Comprehensive Unraid installation guide
- Setup images directory for icons

Features:
- Free HTTPS subdomains via nsl.sh
- Automatic routing for Docker containers
- WireGuard VPN secured connection
- No port forwarding required
- Clean URL pattern: appname.username.nsl.sh

Template location: /unraid/nsl-router.xml
Documentation: /unraid/README.md
Icon (pending): /unraid/images/nsl-router.png

Author: Yundera Team"

# GitHub에 푸시
git push origin main

🎨 필요한 이미지 파일

1. nsl-router.png (템플릿 아이콘)

  • 크기: 256x256px (권장)
  • 형식: PNG (투명 배경 권장)
  • 위치: /unraid/images/nsl-router.png
  • 용도: Community Applications 앱 목록에 표시

디자인 아이디어:

  • 라우터/네트워크 아이콘
  • 자물쇠 (보안 강조)
  • 구름 (클라우드 서비스)
  • NSL 또는 mesh 텍스트
  • Yundera 브랜드 컬러

2. yundera-logo.png (개발자 프로필)

  • 크기: 256x256px 이상
  • 형식: PNG
  • 위치: /unraid/images/yundera-logo.png
  • 용도: 개발자 프로필 표시

✅ 완료 후 확인사항

1. GitHub에서 URL 확인

https://raw.githubusercontent.com/Yundera/mesh-router/main/unraid/nsl-router.xml
https://raw.githubusercontent.com/Yundera/mesh-router/main/unraid/images/nsl-router.png

브라우저에서 직접 접근해서 파일이 보이는지 확인

2. XML 유효성 검증

  • nsl-router.xml을 텍스트 에디터로 열기
  • XML 문법 오류 없는지 확인
  • 모든 태그가 올바르게 닫혔는지 확인

3. URL 경로 확인

  • TemplateURL이 올바른지 확인
  • Icon URL이 올바른지 확인
  • Support, Project URL 확인

🔜 다음 단계: Unraid 포럼 제출

파일 업로드가 완료되면:

  1. Unraid 포럼에 Support 스레드 생성

    • 위치: Docker Containers 섹션
    • 제목: [Support] Yundera - NSL Router: Free HTTPS Domains
    • 내용: unraid-forum-support-thread.md 사용

  2. Community Applications에 제출 요청

    • 포럼 스레드에 언급
    • GitHub 저장소 URL 공유
    • 모더레이터가 검토 후 승인

  3. 테스트

    • 자신의 Unraid에서 먼저 테스트
    • Apps → Settings → Template repositories
    • https://github.com/Yundera/mesh-router 추가
    • NSL Router 검색 및 설치 테스트

📞 도움이 필요하면

작업 완료 체크리스트:

  • unraid 폴더 생성
  • nsl-router.xml 업로드
  • ca_profile.xml 업로드
  • README.md 업로드
  • images 폴더 생성
  • nsl-router.png 업로드 (이미지 준비 후)
  • yundera-logo.png 업로드 (이미지 준비 후)
  • GitHub에서 URL 테스트
  • Unraid 포럼 Support 스레드 생성
  • 자신의 Unraid에서 설치 테스트