Skip to content
Phaset Docs

Installation Deep Dive

Phaset runs on a single host within your infrastructure of choice—local, on-prem, or cloud—and is deliberately intended to be straightforward to get working.

System Requirements

Section titled “System Requirements”

Operating System:

  • Linux (any modern distribution)
  • macOS

Runtime:

Hardware:

  • Works on anything that runs Linux

Network:

  • Internet access during initial installation (to download Phaset)
  • SMTP server access (for authentication emails)
  • Inbound network access for users and integrations

Quick Start

Section titled “Quick Start”

The fastest way to install Phaset is using the one-line installer:

Terminal window
curl -sSL https://releases.phaset.dev/install.sh | bash

This installs the Phaset CLI to ~/.local/bin/phaset. You may need to add this directory to your PATH:

Terminal window
export PATH="$HOME/.local/bin:$PATH"

Installation Steps

Section titled “Installation Steps”
  1. Install the Phaset CLI using the quick start command above.
  2. Install the Phaset API: phaset install. This downloads and installs the Phaset API to ~/.phaset/.
  3. Create a configuration file in your desired working directory: phaset init. This creates a phaset.config.json template file.
  4. Configure Phaset by editing phaset.config.json with your settings (see Configuration below).
  5. Start Phaset: phaset start. The API server will start and display the URL where Phaset is accessible.

That’s it! Phaset is now running on your infrastructure.

Configuration

Section titled “Configuration”

See the dedicated Configuration page for any details about that subject.

CLI Commands

Section titled “CLI Commands”

The Phaset CLI provides several commands for managing your installation:

Terminal window
# Install the Phaset API
phaset install


# Check for and install updates
phaset upgrade


# Create a config file template
phaset init


# Start the Phaset API server
phaset start


# Validate your Phaset license key
phaset license


# Activate your Phaset license key
phaset activate         # Implicit: picks "phaset.licenseKey" value from local phaset.config.json
phaset activate <key>.  # Explicit


# Deactivate your Phaset license key
phaset deactivate       # Implicit: picks "phaset.licenseKey" value from local phaset.config.json
phaset deactivate <key> # Explicit


# Read the Phaset documentation
phaset docs


# Read the Phaset software agreement
phaset legal


# Remove Phaset from your system
phaset uninstall

Updating Phaset

Section titled “Updating Phaset”

To update to the latest version:

Terminal window
phaset upgrade

This checks for updates and installs them automatically. Your configuration and data are preserved.

Data Storage

Section titled “Data Storage”

Phaset stores all data locally on your host:

  • Installation: ~/.phaset/ (API binary and version info)
  • Configuration: phaset.config.json (in your working directory)
  • Data: Local database files (in your working directory)