빠른 시작

1. Quick Start 개요

OrbiSync는 PC·IoT 장치를 클라우드와 안전하게 연결하고, 원격 접속·이벤트 수집·파일 동기화를 제공하는 플랫폼입니다. PC Node는 대시보드(웹 UI)에서 다운로드한 뒤 실행하고, 대시보드에서 확인한 Pairing Code를 입력하면 자동으로 페어링·등록됩니다. 수동 설정 없이 다운로드 → 실행 → Pairing Code 입력만으로 연결이 완료됩니다.

2. 준비물

• OrbiSync 계정 – orbisync.io에서 가입 후 로그인
• 인터넷이 연결된 PC – 지원 OS: Windows, macOS, Linux (실제 지원되는 OS만 사용 중인 경우 해당 OS만 명시)
• Pairing Code – 대시보드에서 생성·확인 (Step 1에서 안내)

3. Step 1. 로그인 후 Pairing Code 확인

1. OrbiSync에 로그인한 뒤 대시보드로 이동합니다.
2. 대시보드에서 Pairing Code를 생성·확인합니다.
   • 위치: 대시보드 상단 가이드 영역의 「Node 추가하기」 버튼 클릭 → 등록 키(Pairing Code) 발급/표시
   • 또는 내 장치 메뉴(/user/nodes)에서 등록 키(Pairing Code) 섹션으로 이동해 발급·확인할 수 있습니다.
3. Pairing Code는 내 계정·슬롯에 장치를 연결하는 일회성 코드입니다. Node 실행 시 이 코드를 입력하면 해당 계정에 자동 등록됩니다.

※ 스크린샷: "대시보드에서 Pairing Code 표시 화면" – 대시보드에서 Node 추가하기/등록 키 발급 위치를 보여주는 이미지를 배치하면 좋습니다.

4. Step 2. PC Node 다운로드

1. 대시보드에서 Node 프로그램 다운로드 영역으로 이동합니다.
2. 「Node 설치하기」 또는 「Node 프로그램 다운로드」 버튼을 클릭합니다.
3. OS별 설치 파일을 받습니다.
   • Windows: 설치 실행 파일(.exe) 또는 ZIP
   • macOS: .dmg 또는 .pkg
   • Linux: .deb / .rpm 또는 바이너리 (제공되는 형태에 맞게 명시)

※ 스크린샷: "대시보드에서 다운로드 버튼" – Node 설치하기/다운로드 버튼 위치를 보여주는 이미지를 배치하면 좋습니다.

5. Step 3. PC Node 실행 & Pairing Code 입력

1. 실행: 다운로드한 Node 프로그램을 실행합니다 (더블클릭 또는 터미널에서 실행 등, 실제 제품 방식에 맞게 사용).
2. 실행 후 Pairing Code 입력 화면이 나오면, Step 1에서 확인한 코드를 그대로 입력합니다.
3. 정상 동작 시 예상 메시지: Registered, Connected, Pairing success 등 (제품에서 사용하는 문구로 통일 권장).

실패 시 흔한 원인 3가지

• 코드 오타 – Pairing Code를 복사·붙여넣기로 입력하거나, 띄어쓰기/앞뒤 공백이 들어가지 않았는지 확인하세요.
• 코드 만료 – Pairing Code는 유효 시간이 있습니다. 대시보드에서 새로 발급(재발급) 후 다시 입력하세요.
• 네트워크 – PC의 인터넷 연결, 방화벽·프록시 설정을 확인하세요. 회사/학교 네트워크에서는 일부 포트가 막혀 있을 수 있습니다.

6. Step 4. 대시보드에서 연결 확인

1. 내 장치 또는 데이터 조회 메뉴로 이동합니다 (사이드바: 내 장치 /user/nodes, 데이터 조회 /user/data).
2. 장치 상태 탭에서 해당 Node가 ONLINE으로 표시되는지 확인합니다.
3. 마지막 연결 시간이 방금 시간으로 갱신되었는지 확인합니다.
4. (해당하는 경우) Tunnel 도메인이 표시되면, 이 주소로 터널을 통해 Node에 접속할 수 있습니다.

※ 스크린샷: "Node ONLINE 확인 화면" – 데이터 조회·장치 상태 탭에서 ONLINE·마지막 연결 시간이 보이는 화면을 배치하면 좋습니다.

7. 다음 단계 (Next Steps)

• 내 장치에서 이벤트/센서 로그 보기 – 데이터 조회 → 이벤트/센서 로그 탭
• 파일 동기화 기능 사용하기 – (해당 문서 경로가 있으면 링크)
• 터널로 로컬 서비스 노출하기 (선택) – (해당 문서 경로가 있으면 링크)

관련 문서:

• 어떻게 동작하나요? – Hub, Node, Sync 동작 원리
• 설치 & 설정 – 상세 설치 및 환경 설정
• 튜토리얼 – 실제 사용 사례

8. Troubleshooting

Pairing Code 관련

• 오타: 복사·붙여넣기 사용, 앞뒤 공백 제거
• 만료: 대시보드에서 「pairing code 재발급」 또는 새 Pairing Code 발급 후 재입력
• 이미 사용됨: 한 번 사용된 코드는 재사용 불가. 새 코드를 발급받아 입력

방화벽/프록시

회사·학교 네트워크에서는 WebSocket/HTTPS 포트가 제한될 수 있습니다. 가능하면 일반 인터넷 환경에서 먼저 연결을 확인해 보세요.

Node가 ONLINE이 안 뜰 때 체크리스트

• Node 프로그램이 종료되지 않고 실행 중인가?
• PC 인터넷 연결이 되는가?
• Pairing Code를 올바르게 입력했는가? (재발급 후 다시 시도)
• 몇 분 지나도 OFFLINE이면 Node를 한 번 종료 후 다시 실행해 보세요.

---

Changelog (문서 변경 요약)

• 플로우 변경: 기존 “Slot 발급·토큰/환경 변수 수동 설정” 방식 제거. 현재 제품은 대시보드에서 Node 다운로드 → 실행 → Pairing Code 입력으로 통일.
• 준비물: Hub URL·Python 요구사항 제거. OrbiSync 계정, 인터넷 연결 PC, Pairing Code(대시보드 확인) 중심으로 정리.
• 단계 재구성: Step 1 Pairing Code 확인 → Step 2 Node 다운로드 → Step 3 실행 및 코드 입력 → Step 4 대시보드에서 ONLINE·터널 확인 순서로 재작성.
• UI 기준: 버튼/메뉴명을 현재 제품과 맞춤 (Node 설치하기, Node 추가하기, 내 장치, 데이터 조회, 등록 키(Pairing Code) 등).
• Tunnel 도메인: “웹서버 미실행 시 접속 실패할 수 있음” 안내 추가.
• Legacy: 구버전 수동 등록/복잡한 설정 내용은 본문에서 제거하고, 필요 시 별도 Legacy 섹션 또는 다른 문서로 이전할 수 있음.