Getting started

Install and update

The desktop app is installed on Windows or macOS. It starts a local server on this PC that handles database connections, so it can also connect to databases on your company network or on this PC. The web app is not installed; you open it in a browser. The differences between the two are explained in Web and desktop.

Choosing an installer

OSInstaller
macOS, Apple silicon (M1 and later)NeoSQL-mac-arm64.dmg
macOS, IntelNeoSQL-mac-x64.dmg
Windows, 64-bitNeoSQL-win-x64-Setup.exe
  • Download the installer from the NeoSQL website, where this guide is. The website detects your PC's OS and offers the matching file first. Files are downloaded from the latest NeoSQL release on GitHub.
  • To see which chip your Mac has, choose Apple menu › About This Mac.
  • You do not need to install Java or JDBC drivers. The app includes a Java runtime, the local server and the JDBC drivers for the supported databases.

Installing on macOS

  1. Download the .dmg file for your chip.
  2. Open the downloaded file and drag the NeoSQL icon to the Applications folder.
  3. Open NeoSQL from the Applications folder or Launchpad. If macOS asks whether to open an app downloaded from the internet, choose Open.

The macOS installers are signed with an Apple developer certificate and notarized by Apple. Do not use files passed to you from anywhere other than the website.

Installing on Windows

  1. Download the NeoSQL-win-x64-Setup.exe file.
  2. Run the downloaded file. It installs right away without a setup wizard, and NeoSQL opens when installation finishes.
  3. From then on, open NeoSQL from the shortcut on the desktop or in the Start menu.
  • NeoSQL is installed for the Windows user who is signed in, without administrator rights (%LOCALAPPDATA%\Programs\neosql). You cannot choose the installation folder, and other Windows users on the same PC install it separately.
  • The installer is code-signed by unvus Co.,Ltd. Even a signed file can trigger a warning from the browser or Windows SmartScreen until enough download history has built up. Check that the publisher shown in the warning's details is unvus Co.,Ltd. before you run it.
  • If installation is blocked on a company PC, ask your IT administrator to allow this installer.
  • Uninstalling the app does not delete the local projects and settings stored on this PC. If you install it again, you continue where you left off.

Updates

Automatic updates

The desktop app checks for a new version when it starts, and when the NeoSQL server announces that a new version has been released.

  • If there is a new version, the download starts right away. A Update Available notification appears, and the progress is shown in the status bar at the bottom while it downloads.
  • When the download finishes, the Update Ready dialog appears.
    • The Restart Now button: asks about unsaved changes first, then closes the app, installs the new version and opens it again.
    • The Later button: keeps the current version for now and installs the new one when you quit the app.
  • If you postpone, a Restart to update to vx.y.z button stays next to the logo in the header. Click it to open the same dialog again.
  • If something goes wrong during the update, an error notification appears and an Update Error indicator stays next to the logo in the header.

Checking manually

  1. Click the app menu button at the left end of the header.
  2. Click the App menuCheck for Updates item.
  3. Check the result.
ResultWhat you see
You are on the latest versionA You're up to date notification
A new version is availableThe download starts. If it has already been downloaded, the Update Ready dialog opens again.
A new version is out but no download is available yetA Update download unavailable notification. Check again later.
The check failed (network problems and the like)A Update Check Failed notification

The version you are using is shown next to the logo in the header, as a number starting with v.

Release notes

  • The first time you start a new version, the Release notes — x.y.z window appears once. It also appears on the first start after a fresh installation. Once you close the window or click the OK button, it does not appear again for that version.
  • With the app in Korean, the Korean release notes are shown, or the English ones if there are no Korean notes. With the app in English, only English release notes are shown.
  • If the release notes cannot be fetched (for example, where internet access is blocked), the window does not appear.

Updates of the web app

The web app is not installed, so there is nothing to update yourself. When NeoSQL releases a new version, a A new version has been deployed notice appears in the open web app. Save your work, then click the Refresh button to reopen it with the new version.

Using the app where internet access is blocked

The desktop app works without the internet as long as you do not sign in. Local projects are stored on this PC, the local server runs on this PC, and the app connects to databases directly from this PC.

TaskWhere internet access is blocked
InstallationDownload the installer on a PC with internet access, copy it over and install it.
UpdatesBoth checking for a new version (NeoSQL server) and downloading it (GitHub) need the internet. If they cannot be reached, the app moves on without an error. Your IT administrator distributes new versions as new installers; installing over the old version keeps your projects and settings.
Sign-in and account projectsNot available. Signing in requires the browser to reach the NeoSQL server.
StoreYou cannot get public template packs and domain packs from the Get from Store menu on the home screen.
Release notes and noticesNot shown.
  • The app's communication with outside servers (usage statistics, update checks, notices) quietly gives up when the servers cannot be reached, and does not block your work. What is sent is explained in Security and where your data goes. You can turn off usage statistics with the Usage statistics item on the My pageProfile screen.
  • The local server accepts connections only from inside this PC (127.0.0.1). It uses the first free port starting from 52080 (52180 for NeoSQLEnterprise).