Kitsune.WEBSITE

Documentation for fox-flavored libraries โ€” gathered in one cozy den.

KitsuneScript special

Documentation + tools

Libraries

List generated from folders in /docs.

Repositories

README preview from GitHub (main / configured branch).

kitsune-serv

Branch: main ยท Refreshed: 2026-05-29 16:54

๐ŸฆŠ KitsuneServ

Visual Server Management Console โ€” A portable, all-in-one development environment manager for Windows and Linux. Think of it as a modern, feature-rich alternative to XAMPP/WAMP/MAMP with a beautiful GUI, built-in terminal, database viewer, app store, and more.

!Electron !Platform !License


โœจ Features

๐Ÿ–ฅ๏ธ Desktop Mode (Electron)

  • Beautiful dark-themed GUI with frameless window
  • System tray integration with quick controls
  • One-click start/stop for all services

๐ŸŒ Server Mode (Web)

  • Full management UI accessible via web browser on port 10000
  • Session-based authentication
  • SSE (Server-Sent Events) for real-time updates
  • Perfect for headless servers or remote management

๐Ÿ”ง 16 Managed Services

CategoryServices
Web ServersApache, Nginx, Caddy
DatabasesPostgreSQL, MySQL, MariaDB, MongoDB
LanguagesPHP, Node.js, Go, Bun, Python, Deno
CacheRedis, Memcached
StorageMinIO

๐Ÿ“ฆ Per-Service Features

  • Multi-version management โ€” Install and switch between multiple versions
  • Profile system โ€” Create, rename, and switch between configuration profiles
  • Auto-start โ€” Configure services to start automatically on launch
  • Auto-restart โ€” Automatic restart on crash
  • Health checks โ€” HTTP/TCP health monitoring with response time
  • Resource monitoring โ€” Real-time memory usage per service
  • Log viewer โ€” Live log tailing with ANSI color support
  • Port conflict detection โ€” Warns about port conflicts before starting

๐Ÿ—„๏ธ Built-in Database Viewer

  • Browse databases, tables, and data
  • Execute custom SQL/NoSQL queries
  • Create and drop databases
  • Query history
  • CSV export
  • One-click access to phpMyAdmin/Adminer

๐Ÿ›’ App Store

Install web applications with a single click:

CategoryApps
Database ToolsphpMyAdmin, Adminer
CMSWordPress, Drupal, Joomla, PrestaShop
FrameworksLaravel, Symfony
DevOpsGitea, File Browser, Mailpit
AnalyticsMatomo
EmailRoundcube

Supports custom Git repositories as well.

๐Ÿ–ฅ๏ธ Built-in Terminal

  • Integrated terminal with PATH pre-configured for all installed services
  • Multiple terminal tabs
  • Command history (up/down arrows)
  • ANSI color support

โŒจ๏ธ Command Palette

  • CODE_0 โ€” Fuzzy search to quickly start/stop services, switch panels, and more

๐Ÿ”— PATH Management

  • Add/remove all installed service binaries to your system PATH with one click

๐ŸŽผ Composer Integration

  • Install and manage PHP Composer directly from the UI
  • Run Composer commands with whitelisted safety

๐Ÿ“ Project Management

  • Create and manage projects per language runtime (Node.js, Go, Bun, Python, Deno)
  • Open project folders directly from the UI

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+ โ€” Download
  • npm (comes with Node.js)

Installation

# Clone the repository
git clone https://github.com/nerdrip/kitsune-serv.git
cd kitsune-serv

# Install dependencies
# Linux/macOS:
chmod +x install.sh && ./install.sh

# Windows:
install.bat

Running

Desktop Mode (Electron GUI)

# Linux/macOS
./start.sh

# Windows
start.bat

# Or with npm
npm start

Server Mode (Web Browser)

Access the full management UI via browser โ€” perfect for headless servers or remote access.

# Linux/macOS
./start-server.sh

# Windows
start-server.bat

# Or with npm
npm run server

# With custom settings
KITSUNE_PORT=8080 KITSUNE_USER=admin KITSUNE_PASS=mysecret ./start-server.sh

The server starts on http://localhost:10000 by default. Credentials are printed in the terminal on startup (auto-generated if CODE_0 is not set).

Environment VariableDefaultDescription
CODE_0CODE_0Port to listen on
CODE_0CODE_0Host/interface to bind to
CODE_0CODE_0Login username
CODE_0(auto-generated)Login password

๐Ÿ—๏ธ Building Release Packages

Windows

build.bat

Creates a portable release in CODE_0 with a ZIP archive.

Linux

chmod +x build.sh && ./build.sh

Creates a portable release in CODE_0 with a tar.gz archive.

Using electron-builder directly

# Windows
npm run build:win

# Linux (AppImage, deb, rpm)
npm run build:linux

# macOS
npm run build:mac

# All platforms
npm run build:all

๐Ÿ“‚ Project Structure

KitsuneServ/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ main.js              # Electron main process
โ”‚   โ”œโ”€โ”€ server.js             # Server mode (web UI)
โ”‚   โ”œโ”€โ”€ preload.js            # Electron preload (context bridge)
โ”‚   โ”œโ”€โ”€ config-manager.js     # Configuration management
โ”‚   โ”œโ”€โ”€ download-manager.js   # Version download & extraction
โ”‚   โ”œโ”€โ”€ service-manager.js    # Service lifecycle management
โ”‚   โ”œโ”€โ”€ db-viewer.js          # Database viewer (SQL/NoSQL)
โ”‚   โ”œโ”€โ”€ app-store-manager.js  # App store (WordPress, etc.)
โ”‚   โ””โ”€โ”€ renderer/
โ”‚       โ”œโ”€โ”€ index.html        # Main UI layout
โ”‚       โ”œโ”€โ”€ app.js            # Frontend application logic
โ”‚       โ””โ”€โ”€ styles.css         # UI styles
โ”œโ”€โ”€ config/
โ”‚   โ”œโ”€โ”€ kitsuneserv.json      # Main configuration
โ”‚   โ”œโ”€โ”€ downloads.json        # Available versions & URLs
โ”‚   โ””โ”€โ”€ instances.json        # App Store instances
โ”œโ”€โ”€ servers/                   # Installed server binaries
โ”œโ”€โ”€ data/                      # Database data directories
โ”œโ”€โ”€ projects/                  # User project directories
โ”œโ”€โ”€ www/                       # Web document root
โ”‚   โ””โ”€โ”€ apps/                  # Installed web apps
โ”œโ”€โ”€ utils/
โ”‚   โ””โ”€โ”€ adminer/               # Adminer database tool
โ”œโ”€โ”€ temp/                      # Download temp files
โ”œโ”€โ”€ build.bat                  # Windows build script
โ”œโ”€โ”€ build.sh                   # Linux build script
โ”œโ”€โ”€ install.bat                # Windows dependency installer
โ”œโ”€โ”€ install.sh                 # Linux dependency installer
โ”œโ”€โ”€ start.bat                  # Windows desktop start
โ”œโ”€โ”€ start.sh                   # Linux desktop start
โ”œโ”€โ”€ start-server.bat           # Windows server mode start
โ”œโ”€โ”€ start-server.sh            # Linux server mode start
โ””โ”€โ”€ package.json

โš™๏ธ Architecture

Desktop Mode

Renderer (HTML/CSS/JS)  โ†โ†’  preload.js (IPC bridge)  โ†โ†’  main.js (Electron)
                                                            โ”œโ”€โ”€ ConfigManager
                                                            โ”œโ”€โ”€ DownloadManager
                                                            โ”œโ”€โ”€ ServiceManager
                                                            โ”œโ”€โ”€ DbViewer
                                                            โ””โ”€โ”€ AppStoreManager

Server Mode

Browser  โ†โ†’  HTTP/SSE  โ†โ†’  server.js (Node.js)
                              โ”œโ”€โ”€ ConfigManager
                              โ”œโ”€โ”€ DownloadManager
                              โ”œโ”€โ”€ ServiceManager
                              โ”œโ”€โ”€ DbViewer
                              โ””โ”€โ”€ AppStoreManager

The server mode serves the same CODE0 UI files and provides a REST API adapter (CODE1) that maps to the same manager classes. Real-time updates (terminal output, service exits, download progress) are delivered via Server-Sent Events (SSE).


๐Ÿ”’ Security

Server Mode Authentication

  • Session-based authentication with HttpOnly, SameSite=Strict cookies
  • Timing-safe credential comparison (prevents timing attacks)
  • Auto-generated passwords when CODE_0 is not set
  • 24-hour session lifetime
  • Request body size limits (10MB)

General

  • Path traversal protection on all file operations
  • Shell command injection prevention (whitelisted Composer commands, no shell interpolation)
  • URL validation for external links (HTTP/HTTPS only)
  • Project name sanitization
  • File operations restricted to app root directory

๐Ÿค Contributing

1. Fork the repository 2. Create a feature branch: CODE0 3. Commit your changes: CODE1 4. Push to the branch: CODE_2 5. Open a Pull Request


๐Ÿ“„ License

This project is licensed under the ISC License.