Skip to content
← Documentation

Installation & Setup

Installation & Setup

This guide covers installing CyberFeeds, 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 ~150 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 CyberFeeds

What the Installer Does

  • Installs the application
  • Creates Start Menu shortcuts
  • Creates Desktop shortcut (optional)
  • Registers file associations (.opml)

Building from Source

Prerequisites

Tool Version
Node.js 18+
npm Latest

Setup

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

# Install dependencies
npm install

# Run in development mode
npm run dev

Build for Production

# Build for Windows
npm run build:win

# Build unpacked directory
npm run build:unpack

Build Outputs

Output Location
NSIS Installer dist/
Unpacked dist/win-unpacked/

Auto-Start

CyberFeeds can launch automatically when you sign in:

Enable/Disable

  • Settings → General → Auto-start with Windows
  • Or: Windows Settings → Apps → Startup → Toggle CyberFeeds

Auto-Update

How It Works

  1. CyberFeeds periodically checks GitHub Releases
  2. When an update is available, a notification appears
  3. Download and install from the prompt

Update Settings

Setting Description
Auto-update Enable/disable automatic checking

Manual Update

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

Data Location

Default Locations

Data Location
Database %APPDATA%\CyberFeeds\db.sqlite
Settings %APPDATA%\CyberFeeds\settings.json
Logs %APPDATA%\CyberFeeds\logs\

Portable Mode

CyberFeeds can run in portable mode:

  • All data stored in application folder
  • No traces in AppData
  • Ideal for USB drives

Uninstallation

Standard Uninstall

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

What Gets Removed

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

What Is Kept

  • Database and settings (in %APPDATA%\CyberFeeds)

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