Installation
Learn how to install CXRay in your environment.
System Requirements
Before installing CXRay, ensure your system meets the following requirements:
- Operating System: Linux, macOS, or Windows
- Memory: Minimum 4GB RAM (8GB recommended)
- Disk Space: At least 10GB available
- Network: Internet connection for downloading dependencies and scanning databases
Installation Methods
Docker Installation (Recommended)
The easiest way to get started with CXRay is using Docker:
docker pull cxray/cxray:latest
docker run -d -p 8080:8080 --name cxray cxray/cxray:latest
Package Manager Installation
Ubuntu/Debian
wget -qO - https://packages.cxray.io/gpg.key | sudo apt-key add -
echo "deb https://packages.cxray.io/apt stable main" | sudo tee /etc/apt/sources.list.d/cxray.list
sudo apt-get update
sudo apt-get install cxray
RHEL/CentOS
sudo rpm --import https://packages.cxray.io/gpg.key
sudo tee /etc/yum.repos.d/cxray.repo <<EOF
[cxray]
name=CXRay Repository
baseurl=https://packages.cxray.io/rpm
enabled=1
gpgcheck=1
EOF
sudo yum install cxray
macOS (Homebrew)
brew tap cxray/tap
brew install cxray
Binary Installation
Download the latest binary for your platform from the releases page:
- Download the appropriate binary for your platform
- Extract the archive
- Move the binary to a location in your PATH
- Make it executable (Linux/macOS):
chmod +x cxray
Verify Installation
After installation, verify that CXRay is properly installed:
cxray --version
Next Steps
- Quick Start Guide - Get started with your first scan
- Configuration - Configure CXRay for your environment