Skip to content

INSTALL.md

Latest commit

 

History

History
172 lines (120 loc) · 3.08 KB

INSTALL.md

File metadata and controls

172 lines (120 loc) · 3.08 KB
Raw

Installation Guide

One-Command Install (Recommended)

Install VPSBench on any supported Linux VPS with one command:

curl -fsSL https://raw.githubusercontent.com/linux-system443/vpsbench/main/install.sh | bash

Then run:

vpsbench quick

Note: The installer requires root/sudo privileges to install system dependencies.

The installer will:

  • Detect your package manager (apt, dnf, yum, pacman)
  • Install required system dependencies (Python 3, fio, sysbench, iputils-ping, git)
  • Create a virtual environment at /opt/vpsbench/venv
  • Install VPSBench into the virtual environment
  • Create a global vpsbench command at /usr/local/bin/vpsbench
  • Verify the installation with vpsbench --version

Prerequisites

  • Python 3.10 or later
  • pip package manager
  • Linux operating system (Debian/Ubuntu recommended)

Install from PyPI (when published)

pip install vpsbench

Install from Source

git clone https://github.com/linux-system443/vpsbench.git
cd vpsbench
pip install .

Development Install

git clone https://github.com/linux-system443/vpsbench.git
cd vpsbench
pip install -e ".[dev]"

System Dependencies

VPSBench requires certain system tools for benchmarking.

Required Dependencies

# Debian/Ubuntu
sudo apt update
sudo apt install fio sysbench iputils-ping

# AlmaLinux/Rocky Linux/Fedora
sudo dnf install fio sysbench iputils

Optional Dependencies

# For Docker benchmarks (Minecraft, Docker overhead)
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
# Log out and back in for group changes to take effect

# For contention testing
sudo apt install stress-ng

# For advanced network diagnostics
sudo apt install mtr-tiny

# For network throughput testing
sudo apt install iperf3

Full Install (Debian/Ubuntu)

sudo apt update && sudo apt install -y \
    fio \
    sysbench \
    iputils-ping \
    stress-ng \
    mtr-tiny \
    iperf3

# Docker (optional)
curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER

Verify Installation

vpsbench --version
vpsbench --help

Configuration

Copy the example config and customize:

python -c "from vpsbench.config.loader import generate_config_file; generate_config_file()"

Edit vpsbench.yaml as needed.

Running

# Full gaming benchmark
vpsbench

# Quick benchmark
vpsbench quick

# Specific tests
vpsbench cpu
vpsbench disk
vpsbench network

# Save results
vpsbench --json results.json

Troubleshooting

"Permission denied" errors

Some benchmarks require elevated privileges. Run with sudo if needed:

sudo vpsbench

Docker permission denied

Add your user to the docker group:

sudo usermod -aG docker $USER
# Log out and back in

fio permission errors

If using direct=1, you may need root access:

sudo vpsbench disk

Slow network tests

Network tests depend on external servers. If tests are slow:

  1. Check your internet connection
  2. Try different regions: vpsbench network
  3. Customize endpoints in config file