시작 흐름

NeoSQL 공식 사이트에 접속해 로그인 페이지에서 인증하면 대시보드로 이동합니다. 참여 중인 프로젝트가 표시되며, "새 프로젝트" 로 만들거나 기존 프로젝트를 선택해 작업을 이어갈 수 있습니다. 회원가입 · 로그인 · 프로젝트 관리의 자세한 절차는 다음 가이드를 참고하세요.

• 회원가입 가이드
• 소셜 로그인 가이드
• 프로젝트 생성/수정/삭제 가이드

macOS 설치 (Apple Silicon)

Apple Silicon Mac 에서 NeoSQL 데스크톱 앱을 설치하는 방법입니다.

Windows 설치

Windows PC 에 NeoSQL 데스크톱 앱을 설치하는 방법입니다. Microsoft SmartScreen 이 다운로드 단계와 실행 단계에서 안내창을 띄울 수 있으므로 다음 절차를 순서대로 따라가세요.

1

설치 파일 다운로드

NeoSQL 공식 사이트에서 Windows 용 설치 파일 NeoSQL-win-x64-Setup.exe 를 다운로드합니다.

2

다운로드 SmartScreen 차단 해제 (Microsoft Edge)

Microsoft SmartScreen 은 코드 서명이 없는 신규 배포 파일을 다운로드 단계에서 일시 차단할 수 있습니다. 차단 안내가 표시되면 아래 이미지의 흐름에 따라 파일을 유지합니다. (Microsoft Edge 가 다른 브라우저보다 SmartScreen 검사를 더 엄격하게 적용합니다.)

3

실행 SmartScreen 경고 통과 (Windows)

다운로드한 설치 파일을 실행합니다. Windows SmartScreen 이 "PC를 보호했습니다" 창을 띄우면 "추가 정보" → "실행" 을 클릭해 설치를 진행합니다.

4

설치 완료 및 방화벽 허용

설치 마법사의 안내에 따라 진행하면 바탕화면과 시작 메뉴에 NeoSQL 바로가기가 생성됩니다. 별도의 환경변수 설정이나 Java 설치는 필요하지 않으며, neosql:// 딥링크 핸들러도 자동으로 등록됩니다. 첫 실행 시 Windows 방화벽 경고가 나타나면 "액세스 허용" 을 선택해 NeoSQL 이 DB 와 정상 통신할 수 있도록 합니다.

자격증명 저장 위치

데스크톱 앱은 DB 접속 비밀번호와 SSH 키 등 자격증명을 OS 보안 저장소에 암호화하여 저장합니다.

• macOS — macOS Keychain 에 사용자 계정 단위로 암호화되어 저장됩니다.
• Windows — Windows 자격증명 보안 저장소(DPAPI) 에 현재 사용자 계정 단위로 암호화되어 저장됩니다.

자동 업데이트 동작

데스크톱 앱은 실행 시 자동으로 새 버전을 확인하고 백그라운드로 다운로드합니다. 다운로드가 완료되면 "지금 재시작" / "나중에" 를 선택할 수 있는 안내가 표시되며, "나중에" 를 선택하면 다음 앱 종료 시 자동으로 새 버전이 적용됩니다. 폐쇄망 환경에서는 자동 업데이트가 동작하지 않으므로 IT 관리자가 새 설치 파일을 배포해야 합니다.

시작 흐름

설치된 데스크톱 앱에서 "브라우저로 로그인" 을 클릭하면 기본 브라우저로 인증 페이지가 열리고, 인증이 끝나면 neosql:// 딥링크 핸들러를 통해 데스크톱 앱으로 자동 복귀합니다. 이후 대시보드에서 새 프로젝트를 만들거나 기존 프로젝트를 선택해 작업을 시작할 수 있습니다. 회원가입 · 로그인 · 프로젝트 관리의 자세한 절차는 다음 가이드를 참고하세요.

• 회원가입 가이드
• 소셜 로그인 가이드
• 프로젝트 생성/수정/삭제 가이드

오프라인 모드 진입

데스크톱 앱을 실행한 뒤 로그인 화면 하단의 "오프라인 로그인" 링크를 클릭하면 라이선스 키 입력 화면으로 이동합니다.

라이선스 적용 및 인증

JSON 키 파일을 드래그 앤 드롭(또는 업로드) 하면 라이선스 키와 아래 3개 파라미터가 자동으로 채워집니다. "Remember Me" 를 선택하면 다음 실행 시 자동으로 다시 채워지며, "오프라인 인증" 버튼을 클릭해 검증이 끝나면 프로젝트 선택 화면으로 이동합니다. 라이선스 만료일이 지나면 세션이 자동으로 종료되고, 만료 24시간 이내가 되면 앱에 경고 알림이 표시되어 갱신을 안내합니다. 키 파일이 없거나 갱신이 필요한 경우 라이선스 (Offline) 가이드를 참고하세요.

폐쇄망 사내 배포 가이드

IT 관리자는 다음 흐름으로 폐쇄망에 NeoSQL 을 배포할 수 있습니다.

1. 외부망 PC 에서 데스크톱 설치 파일과 사용자별 라이선스 키 파일을 사전에 다운로드합니다.
2. USB · 사내 파일 서버 등 허용된 채널로 설치 파일과 키 파일을 폐쇄망 PC 에 전달합니다.
3. 각 사용자가 데스크톱 앱을 설치한 뒤 오프라인 모드 진입 화면에서 키 파일을 등록합니다.
4. 업데이트 · 키 갱신이 필요할 때마다 동일한 절차로 새 파일을 배포합니다.

오프라인 프로젝트 관리

Offline 모드에서는 로컬 파일 시스템 기반으로 프로젝트를 관리합니다. 프로젝트 단위로 디렉토리를 지정해 새로 만들거나, 기존 .neosql/ 폴더가 있는 디렉토리를 그대로 불러올 수 있습니다.

새 프로젝트 생성

기존 프로젝트 불러오기

데이터 저장 위치

Offline 모드의 모든 작업 데이터는 프로젝트 디렉토리의 .neosql/ 폴더에 JSON 파일로 저장됩니다. 비밀번호 · SSH 키 같은 민감한 자격증명만 별도로 OS 보안 저장소(macOS Keychain / Windows DPAPI) 에 암호화 저장되어 .neosql/ 폴더에는 포함되지 않습니다.

{project-root}/.neosql/
├── project-config.json                        # 프로젝트 설정 (이름, DBMS, 템플릿 팩)
├── connections/                               # DB 연결 정보
│   └── {connectionId}_{connectionName}/       # 연결별 디렉토리
│       ├── connection.json                    # 연결 설정 (호스트, 포트, 드라이버 등). 비밀번호 미포함
│       └── {schemaName}/                      # 스키마별 디렉토리
│           ├── {tableName}.json               # 테이블 정의 (컬럼, 인덱스, FK 등)
│           └── {tableName}_entity.json        # Java Entity 매핑 정보
├── erd/                                       # ERD 다이어그램
│   └── {erdId}.json                           # ERD 정의 (노드, 엣지, 레이아웃)
└── sql/                                       # SQL Editor 파일
    └── {sqlId}.json                           # SQL 쿼리 본문 및 결과 캐시