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)
- Download the latest installer from Releases
- Run the
.exe installer
- Follow the setup wizard
- Launch CyberNotes
What the Installer Does
- Installs the application
- Creates Start Menu shortcuts
- Creates Desktop shortcut (optional)
- Offers to start with Windows
Portable
- Download the portable build from releases
- Run directly — no installation needed
- 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
- CyberNotes checks GitHub Releases on startup
- Background check every 6 hours
- Progress bar shows download status
- Auto-download and restart when complete
Update Settings
| Setting |
Description |
| Auto-check updates |
Enable/disable update checking |
Manual Update
- Go to Settings → System → Check for Updates
- 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
- Windows Settings → Apps → Installed Apps
- 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.