Skip to content GitHub
Guide contents
English View source

Installation and Setup

Installation and Setup

This guide covers installing CyberViewer on Windows, running it from source, managing integrations, and keeping it up to date.

System Requirements

Requirement Supported setup
Operating system Windows 10 or Windows 11.
Architecture 64-bit x64.
Installed runtime None. The installer and portable build include Electron.

Installation Methods

Windows Installer

The installer is the recommended option for regular use:

  1. Download the latest CyberViewer-Setup-<version>.exe from GitHub Releases.
  2. Run the installer.
  3. Choose the installation directory and follow the setup wizard.
  4. On the default viewer page, leave the checkbox enabled if you want CyberViewer registered for supported image types.
  5. Finish the installation and launch CyberViewer.

The default viewer option is enabled by default and writes per-user Windows associations. It can be changed later under Windows Settings > Apps > Default apps.

The installer also creates Start Menu and Desktop shortcuts, supports English and Spanish, and includes both the application and its Electron runtime.

Portable Build

  1. Download CyberViewer-Portable-<version>.exe from GitHub Releases.
  2. Store it in the folder where you want to keep the portable executable.
  3. Run it directly. No installation wizard is required.

The portable build does not apply the installer's file associations automatically. Use Windows Default apps if you want to associate image types manually.

Windows SmartScreen

Windows may display a SmartScreen warning for a new installer or portable build while reputation is being established. This is expected for an unsigned release.

To continue with a file you trust:

  1. Click More info.
  2. Click Run anyway.

Only run a downloaded file after verifying that it came from the official GitHub Releases page.

Building from Source

Prerequisites

Tool Requirement
Windows Windows 10 or Windows 11, x64.
Node.js Current LTS release.
npm Included with Node.js.

Development Setup

git clone https://github.com/CyberGems/CyberViewer.git
cd CyberViewer
npm install
npm start

Validation

npm test
npm run lint
npm run i18n:sync

npm run i18n:sync regenerates the runtime localization loader after changing i18n/ui.json.

Production Builds

# Build the NSIS installer and portable executable
npm run build

# Build only the portable executable
npm run build:portable

Build artifacts are written to dist/:

Artifact Description
CyberViewer-Setup-<version>.exe NSIS installer.
CyberViewer-Portable-<version>.exe Portable Windows executable.

Auto-Start with Windows

Open Settings > System > Auto-start to launch CyberViewer with Windows in a minimized state. The setting uses the current Windows user and can also be managed from Windows Settings > Apps > Startup.

Auto-Updates

Installed NSIS builds use the GitHub Releases update channel:

  1. CyberViewer checks for a new version at startup when Check for updates on startup is enabled in About.
  2. You can also choose Help > Check for updates or use About > Check for Updates.
  3. If an update is available, choose Download update.
  4. When the download is ready, choose Install and restart.

The download and installation are always user-requested. Portable builds cannot self-update inside the app, so download a new portable executable from Releases instead.

System Tray

Enable Settings > System > Close to tray to keep CyberViewer running in the notification area when the main window is closed.

The tray menu provides:

Action Result
Show / Hide Toggle the main viewer window.
Recent images Open one of up to 10 recent images or clear the list.
Settings Open CyberViewer settings.
Help and About Open documentation, FAQ, changelog, website, donations, or update controls.
Exit Quit CyberViewer completely.

The Close image on tray hide option unloads the current image while keeping its path in Recent images. The tray icon can be managed through Windows notification area settings if it is hidden in the overflow area.

Explorer Context Menu

Open Settings > System > Context menu to add a CyberViewer action to the Windows Explorer right-click menu for supported image files. The integration is stored for the current Windows user and can be disabled from the same setting.

File Associations

The installer can register CyberViewer as a viewer for these extensions:

Format Extensions
JPEG .jpg, .jpeg
PNG .png
GIF .gif
WebP .webp
BMP .bmp
TIFF .tif, .tiff
Icon .ico
AVIF .avif

The registration is per user. Windows may require an explicit choice in Settings > Apps > Default apps before it changes the default viewer.

Multiple Instances

CyberViewer uses one application instance by default. Open file requests are forwarded to the existing window.

Enable Settings > System > Multiple Instances to allow more than one window. The setting takes effect after the next launch. A window launched directly with an image file is independent when multiple instances are enabled.

Uninstallation

Standard Uninstall

  1. Open Windows Settings > Apps > Installed apps.
  2. Find CyberViewer.
  3. Choose Uninstall.

The uninstaller removes the installed program, its shortcuts, the associations created by the installer, and the auto-start entry.

User Data

Application settings and thumbnail data are stored separately from the program files, normally under %APPDATA%\CyberViewer. Uninstalling does not remove this user data.

To remove it completely, close CyberViewer and delete that folder manually after uninstalling. This also removes saved preferences, favorites, recent history, and the thumbnail cache.

← All documentation