Installation - Pharos Documentation

Pharos is designed for “60-second success.” Our automated installer detects your environment and sets up the requested component with minimal friction.

🚀 The One-Liner (Recommended)

Run the following command on your target machine (Ubuntu, Debian, macOS, or WSL):

curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- [hub|node]

Replace [hub|node] with the appropriate role for your machine:

hub: (Recommended for your main server) Installs the Pharos Server, Web Console, and Scan Engine.
node: (Recommended for managed nodes) Installs the Pulse Agent, mdb, and ph CLI tools.

🛠️ Role Selection

🏠 Home Lab: The “All-in-One” Hub

Most Home Labbers want a single “Hub” that hosts the server and manages the network, while existing and future nodes run the lightweight “Node” bundle.

1. Set Up The Hub (Main Server)

Run this on your primary Ubuntu/Debian host (e.g., a Proxmox LXC):

curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- hub

2. Set Up Nodes (Managed Machines)

Run this on every machine or container you want Pharos to track:

PHAROS_HOST="192.168.1.5" curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- node

🏢 Enterprise: Granular Deployment

Enterprise environments typically use configuration management (Ansible/Terraform) to deploy components individually.

1. Deploy the Protocol Server

curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- server

2. Mass Deploy Pulse Agents

PHAROS_HOST="pharos.enterprise.com" curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- pulse

3. Install the Toolbelt (Workstations)

curl -sSL https://raw.githubusercontent.com/iamrichardD/pharos/main/scripts/install.sh | bash -s -- toolbelt

📋 Prerequisites

Requirement	Supported Versions
OS	Ubuntu 22.04+, Debian 12+, macOS (Intel/M-series), WSL2
Arch	x86_64, aarch64
Dependencies	`curl`, `tar` (Automatically checked)

🔍 Post-Installation Checklist

After running the installer, verify your setup:

Server: sudo systemctl status pharos-server should be active (running).
Pulse: sudo systemctl status pharos-pulse should be active (running).
Agent-Native Control Plane: Access https://your-server-ip:3000 to verify the Web Console UI.
CLIs: Run mdb status to verify CLI path injection.

🛑 Manual Installation

If your environment is air-gapped or restricted, you can download the binaries directly from our GitHub Releases.

Download the appropriate .tar.gz for your OS/Arch.
Extract to /usr/local/bin.
(Optional) Configure systemd services manually as described in Server Setup.