Installation

This guide walks you through installing NkapBooks on your preferred platform.

System Requirements

Before installing, ensure your system meets the minimum requirements:

Windows

• Windows 10 or Windows 11
• 4GB RAM (8GB recommended)
• 500MB available disk space
• 64-bit processor

macOS

• macOS 11 Big Sur or later
• 4GB RAM (8GB recommended)
• 500MB available disk space
• Intel or Apple Silicon processor

Linux

• Ubuntu 20.04+ or equivalent distribution
• 4GB RAM (8GB recommended)
• 500MB available disk space
• 64-bit processor

Windows Installation

Using the Installer (Recommended)

1. Download the latest .exe installer from the downloads page
2. Double-click the downloaded file to run the installer
3. If Windows Defender SmartScreen appears, click "More info" then "Run anyway"
4. Follow the installation wizard
5. Launch NkapBooks from the Start Menu or Desktop shortcut

Using MSI Package

For enterprise deployments or silent installations:

# Silent installation
msiexec /i NkapBooks-1.0.0.msi /qn

# Installation with logging
msiexec /i NkapBooks-1.0.0.msi /l*v install.log

macOS Installation

Using DMG (Recommended)

1. Download the appropriate .dmg file:
   • Universal: Works on both Intel and Apple Silicon
   • Apple Silicon: Optimized for M1/M2/M3 Macs
   • Intel: For older Intel-based Macs
2. Double-click the downloaded .dmg file
3. Drag NkapBooks to your Applications folder
4. Open NkapBooks from Applications
5. If prompted about an unidentified developer:
   • Go to System Preferences → Security & Privacy
   • Click "Open Anyway"

Using Homebrew

brew install --cask nkapbooks

To update:

brew upgrade --cask nkapbooks

Linux Installation

AppImage (Universal)

AppImage works on most Linux distributions:

# Download the AppImage
wget https://nkapbooks.io/downloads/NkapBooks-1.0.0.AppImage

# Make it executable
chmod +x NkapBooks-1.0.0.AppImage

# Run the application
./NkapBooks-1.0.0.AppImage

Debian/Ubuntu (.deb)

# Download the package
wget https://nkapbooks.io/downloads/nkapbooks_1.0.0_amd64.deb

# Install using dpkg
sudo dpkg -i nkapbooks_1.0.0_amd64.deb

# Install dependencies if needed
sudo apt-get install -f

Or use apt directly:

sudo apt install ./nkapbooks_1.0.0_amd64.deb

Fedora/RHEL (.rpm)

# Download the package
wget https://nkapbooks.io/downloads/nkapbooks-1.0.0.x86_64.rpm

# Install using dnf
sudo dnf install ./nkapbooks-1.0.0.x86_64.rpm

Flatpak

# Install from Flathub
flatpak install flathub io.gitss.nkapbooks

# Run the application
flatpak run io.gitss.nkapbooks

Verifying Your Download

For security, verify your download using the provided checksums:

Windows (PowerShell)

Get-FileHash NkapBooks-1.0.0-setup.exe -Algorithm SHA256

macOS/Linux

sha256sum NkapBooks-1.0.0.AppImage

Compare the output with the checksums listed on the downloads page.

Updating NkapBooks

Automatic Updates (Pro/Enterprise)

Pro and Enterprise license holders receive automatic update notifications within the app. When an update is available:

1. You'll see a notification in the app
2. Click "Update Now" to download and install
3. Restart the app to complete the update

Manual Updates

For Community edition users:

1. Download the latest version from the downloads page
2. Install over your existing installation
3. Your data will be preserved

Uninstalling

Windows

1. Open Settings → Apps → Apps & features
2. Find NkapBooks and click Uninstall
3. Follow the uninstall wizard

macOS

1. Open Finder → Applications
2. Drag NkapBooks to the Trash
3. Empty the Trash

Linux

# Debian/Ubuntu
sudo apt remove nkapbooks

# Fedora/RHEL
sudo dnf remove nkapbooks

# Flatpak
flatpak uninstall io.gitss.nkapbooks

Data Location

NkapBooks stores your data in the following locations:

Troubleshooting

Windows: "Windows protected your PC" message

This is Windows SmartScreen. Click "More info" then "Run anyway" to proceed.

macOS: "App is damaged and can't be opened"

Run this command in Terminal:

xattr -cr /Applications/NkapBooks.app

Linux: AppImage won't run

Ensure FUSE is installed:

# Ubuntu/Debian
sudo apt install fuse libfuse2

# Fedora
sudo dnf install fuse

Next Steps

After installation, proceed to the Getting Started guide to set up your first company.