Skip to content
← Documentación

Installation & Setup

Installation & Setup

This guide covers installing CyberNotes, building from source, and keeping it up to date.


System Requirements

Requirement Minimum
OS Windows 10 (64-bit) or later
Architecture x64
Runtime None (Electron bundles all dependencies)
Disk space ~200 MB
RAM 4 GB

Installation Methods

Installer (Recommended)

  1. Download the latest installer from Releases
  2. Run the .exe installer
  3. Follow the setup wizard
  4. Launch CyberNotes

What the Installer Does

  • Installs the application
  • Creates Start Menu shortcuts
  • Creates Desktop shortcut (optional)
  • Offers to start with Windows

Portable

  1. Download the portable build from releases
  2. Run directly — no installation needed
  3. Settings stored in application folder

Building from Source

Prerequisites

Tool Version
Node.js v18+ (LTS recommended)
npm Latest

Setup

# Clone the repository
git clone https://github.com/CyberGems/CyberNotes.git
cd CyberNotes

# Install dependencies
npm install

# Run in development mode
npm run dev

Build for Production

# Build Electron app with installer
npm run build:electron

Build Outputs

Output Location
NSIS Installer release/CyberNotes_Setup_X.X.X.exe
Portable release/CyberNotes_Portable_X.X.X.exe

Auto-Start

CyberNotes can launch automatically when you sign in:

Enable/Disable

  • Settings → System → Auto-start
  • Or: Windows Settings → Apps → Startup → Toggle CyberNotes

Auto-Update

How It Works

  1. CyberNotes checks GitHub Releases on startup
  2. Background check every 6 hours
  3. Progress bar shows download status
  4. Auto-download and restart when complete

Update Settings

Setting Description
Auto-check updates Enable/disable update checking

Manual Update

  1. Go to Settings → System → Check for Updates
  2. Or: Download the latest installer from releases

System Tray

Tray Features

  • Minimize to tray
  • Close to tray
  • Custom HTML popup menu
  • DPI-aware positioning

Tray Menu

Right-click the tray icon for:

Action Description
Show/Hide Toggle notes window
New Note Create a new note
Settings Open settings
About Show about dialog
Exit Close CyberNotes

Data Location

Default Locations

Data Location
Database %APPDATA%\CyberNotes\cybernotes.db
Images %APPDATA%\CyberNotes\images\
Settings SQL.js settings table

Uninstallation

Standard Uninstall

  1. Windows Settings → Apps → Installed Apps
  2. Find CyberNotes → Click Uninstall

What Gets Removed

  • Program files
  • Start Menu shortcuts
  • Auto-start entry

What Is Kept

  • Database and images (in %APPDATA%\CyberNotes)

⚠️ To remove all data, manually delete %APPDATA%\CyberNotes after uninstalling.