Getting Started

Installation

Install SkyPort on your platform - Linux, Windows, macOS, Docker, or WSL

SkyPort is available for all major platforms. Choose the installation method that works best for your setup.

Linux

From Release Binary

The fastest way to get started on Linux:

# Download the latest release
wget https://github.com/Nil369/SkyPort/releases/latest/download/skyport-linux-amd64
chmod +x skyport-linux-amd64
sudo mv skyport-linux-amd64 /usr/local/bin/skyport

# Verify installation
skyport --version

# Download the latest release
wget https://github.com/Nil369/SkyPort/releases/latest/download/skyport-linux-arm64
chmod +x skyport-linux-arm64
sudo mv skyport-linux-arm64 /usr/local/bin/skyport

# Verify installation
skyport --version

From Source

Build SkyPort from source:

git clone https://github.com/Nil369/SkyPort.git
cd SkyPort/cli
go build -o skyport ./cmd/main.go
sudo mv skyport /usr/local/bin/

Windows

From Release Binary

# Download the latest release
$url = "https://github.com/Nil369/SkyPort/releases/latest/download/skyport-windows-amd64.exe"
$output = "C:\Users\$env:USERNAME\Downloads\skyport.exe"
Invoke-WebRequest -Uri $url -OutFile $output

# Move to Program Files
New-Item -ItemType Directory -Path "C:\Program Files\SkyPort" -Force
Move-Item -Path $output -Destination "C:\Program Files\SkyPort\skyport.exe" -Force

# Add to PATH (run as Administrator)
$env:Path += ";C:\Program Files\SkyPort"
[Environment]::SetEnvironmentVariable("Path", $env:Path, "Machine")

cd ~
curl -L -o skyport.exe https://github.com/Nil369/SkyPort/releases/latest/download/skyport-windows-amd64.exe
mkdir -p ~/bin
mv skyport.exe ~/bin/
echo 'export PATH=$PATH:~/bin' >> ~/.bashrc

Add to PATH (Manual)

If the automatic PATH update doesn't work:

Press Win + X and select "System"
Click "Advanced system settings"
Click "Environment Variables"
Under "System variables", click "New"
Variable name: SKYPORT_HOME
Variable value: C:\Program Files\SkyPort
Edit the Path variable and add %SKYPORT_HOME%
Click OK and restart your terminal

Verify Installation

skyport --version
skyport help

macOS

From Release Binary

# Download the latest release
curl -L -o skyport https://github.com/Nil369/SkyPort/releases/latest/download/skyport-darwin-amd64
chmod +x skyport
sudo mv skyport /usr/local/bin/

# Verify installation
skyport --version

# Download the latest release
curl -L -o skyport https://github.com/Nil369/SkyPort/releases/latest/download/skyport-darwin-arm64
chmod +x skyport
sudo mv skyport /usr/local/bin/

# Verify installation
skyport --version

Using Homebrew

brew tap Nil369/skyport
brew install skyport

Docker

Run SkyPort in Docker

docker run -d \
  --name skyport \
  --restart unless-stopped \
  -p 8080:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v skyport-data:/root/.skyport \
  nil369/skyport:latest

Using Docker Compose

Create a docker-compose.yml:

version: '3.8'

services:
  skyport:
    image: nil369/skyport:latest
    container_name: skyport
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - skyport-data:/root/.skyport
    environment:
      - SKYPORT_PORT=8080

volumes:
  skyport-data:

Then run:

docker-compose up -d

Windows Subsystem for Linux (WSL)

Install on WSL2

If you're using Windows Subsystem for Linux 2, follow the Linux installation instructions:

# Inside WSL2 terminal
wget https://github.com/Nil369/SkyPort/releases/latest/download/skyport-linux-amd64
chmod +x skyport-linux-amd64
sudo mv skyport-linux-amd64 /usr/local/bin/skyport

# Verify
skyport --version

System Requirements

CPU: 1 core minimum (2+ recommended)
RAM: 512MB minimum (2GB+ recommended)
Storage: 1GB minimum
Network: Internet access for marketplace and updates

First Run

After installation, start the SkyPort server:

skyport start webui

This will:

Start the API server (default port 8080)
Launch the web dashboard
Initialize the configuration directory

Visit http://localhost:8080 in your browser.

Troubleshooting Installation

Command not found

Make sure the installation directory is in your PATH:

# Check PATH
echo $PATH

# Verify SkyPort is installed
which skyport

# If not found, add to PATH
export PATH="/usr/local/bin:$PATH"

Permission Denied

Make sure the binary has execute permissions:

chmod +x /usr/local/bin/skyport
ls -la /usr/local/bin/skyport

Docker Socket Access

If running in Docker and can't access the Docker socket:

# Check socket permissions
ls -la /var/run/docker.sock

# Add user to docker group (Linux)
sudo usermod -aG docker $USER
newgrp docker

Next: Quick Start Guide

Edit this pageorReport an issue

Introduction

Learn what SkyPort is and why it's the perfect self-hosted infrastructure platform

Quick Start

Get SkyPort running in 5 minutes