SkyPort Logo

SkyPort Docs

Getting Started

Installation

Installation & UnInstallation Guide For SkyPort on Linux, Windows, macOS, or WSL.

SkyPort ships as a Go CLI named skyport, plus a separate backend server binary built from backend/.

Minimum System Requirements

SkyPort works on lightweight systems, but the recommended minimums are:

  • 1 vCPU core
  • 512 MB RAM
  • 2 GB RAM+ recommended for Docker-based setups

Linux

Use the release binary or build from source.

Run the uninstall script as root or with sudo.
sudo su

curl -fsSL https://skyport.akashhalder.in/installer.sh | sudo bash
skyport --version

# Setup Systemd in Production/Linux Environments
skyport service install
skyport service start

# Start The Web UI:
skyport start webui

Linux notes

  • skyport must be on your PATH.
  • skyport start webui expects a backend binary such as skyport-server or skyport-backend on PATH, or a custom path passed with --binary.
  • If you hit permission errors, verify the binary mode and Docker socket permissions.
terminal
which skyport
ls -la /usr/local/bin/skyport
  • Installation Locations:
/opt/skyport
/usr/local/bin/skyport
/usr/local/bin/skyport-server

Windows

To Install the CLI binary and the Backend Server binary, then add its folder to PATH.

Open Powershell / GitBash / Terminal as Admin

Simply Search "Terminal/GitBash/Powershell" in Windows Searchbar and then Run as Adminstrator

In Search BarUsing Terminal Tab
irm https://skyport.akashhalder.in/installer.ps1 | iex

skyport --version

# Start The Backend Server:
skyport start server

# Start The Web UI:
skyport start webui

Windows PATH Setup - Manual Method

Default Installation Location on Windows:
C:\Program Files\SkyPort

After installing SkyPort, the skyport command should work globally from PowerShell or Command Prompt.

If the command is not recognized, manually add SkyPort to your Windows PATH. Expand the Show Properties to see the Step!

Managing the SkyPort Backend Server

During installation, SkyPort automatically start the backend server in the background.

Make sure you are running all these command below and above in Administrator Terminal / Powershell / GitBash

Stop the Server

skyport stop # Using the latest Skyport CLI

Start the Server Again

skyport start server # Using the latest Skyport CLI, OR,

skyport start # OR,

skyport restart

Check if the Server is Running

skyport status # Using the latest Skyport CLI

The backend server powers the SkyPort Web UI, API, Docker management, PM2 integration, monitoring system, and other infrastructure services.

macOS

Run the uninstall script as root or with sudo.
installer.bash
sudo su

curl -fsSL https://skyport.akashhalder.in/installer.sh | sudo bash
skyport --version

# Setup Systemd in Production/Linux Environments
skyport service install
skyport service start

# Start The Web UI:
skyport start webui

macOS notes

  • The first run may trigger a Gatekeeper prompt.
  • If the shell cannot find skyport, confirm /usr/local/bin is on PATH.
  • Installation Locations:
/usr/local/skyport
/usr/local/bin/skyport
/usr/local/bin/skyport-server

WSL

WSL behaves like Linux, but Docker access depends on your Windows-side Docker setup.

sudo su

curl -fsSL https://skyport.akashhalder.in/installer.sh | sudo bash
skyport --version

# Setup Systemd in Production/Linux Environments
skyport service install
skyport service start

# Start The Web UI:
skyport start webui

WSL networking notes

  • skyport start webui will usually bind to 0.0.0.0 on Linux and show the detected LAN IP.
  • If you are running Docker Desktop on Windows, make sure WSL integration is enabled.
  • If you access the UI from the Windows host, use the address printed by skyport start webui.
  • WSL Installation Locations: 
    /opt/skyport
/usr/local/bin/skyport
/usr/local/bin/skyport-server

Troubleshooting

Command not found

terminal
which skyport
echo $PATH

Permission denied

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

Docker socket access

terminal
ls -la /var/run/docker.sock
sudo usermod -aG docker $USER
newgrp docker

Build from source fails

Use the repository root targets rather than building only a partial package:

terminal
make frontend-build
make backend-build
make cli-build

UnInstalling SkyPort

Remove SkyPort binaries, configuration, and optional data directories from your system.

Linux

Run the uninstall script as root or with sudo.
sudo su
curl -fsSL https://skyport.akashhalder.in/uninstaller.sh | sudo bash

What gets removed?

The Linux uninstaller removes:

locations
/usr/local/bin/skyport
/usr/local/bin/skyport-server
/etc/skyport
/etc/systemd/system/skyport.service

If SKYPORT_PURGE_DATA=1 is used, it also removes:

data
/opt/skyport

Linux Service Cleanup

The uninstaller automatically:

  • Stops the skyport systemd service
  • Disables auto-start on boot
  • Reloads the systemd daemon
  • Removes the service definition

Verify Removal

terminal
which skyport
systemctl status skyport

If successfully removed:

  • which skyport should return nothing
  • systemctl status skyport should report service not found

Windows

SkyPort for Windows installs into:

path.ps1
C:\Program Files\SkyPort
Open PowerShell as Administrator before uninstalling.
irm https://skyport.akashhalder.in/uninstaller.ps1 | iex

What gets removed?

locations.ps1
C:\Program Files\SkyPort

Including:

binaries.ps1
skyport.exe
skyport-server.exe

The Windows uninstaller also:

  • Removes SkyPort from the user PATH
  • Stops any running skyport-server.exe processes
  • Cleans installation files

Verify Removal

terminal.ps1
skyport --version

If removed correctly:

output.ps1
skyport : The term 'skyport' is not recognized...

macOS

SkyPort on macOS installs using launchd.

Run uninstall commands with sudo.
curl -fsSL https://skyport.akashhalder.in/uninstaller.sh | sudo bash

What gets removed?

locations
/usr/local/bin/skyport
/usr/local/bin/skyport-server
/usr/local/etc/skyport
/Library/LaunchDaemons/in.skyport.server.plist

Optional data removal:

data
/usr/local/skyport

macOS Service Cleanup

The uninstaller automatically:

  • Unloads the launchd daemon
  • Stops SkyPort background services
  • Removes the daemon plist file

Verify Removal

terminal
which skyport
launchctl list | grep skyport

WSL

WSL uses the same Linux uninstall flow.

curl -fsSL https://skyport.akashhalder.in/uninstaller.sh | sudo bash

WSL Notes

  • This removes SkyPort only inside the WSL environment.
  • Docker Desktop integrations on Windows are not modified.
  • If multiple WSL distributions exist, uninstall SkyPort separately inside each distro.

Manual Removal

If the automated uninstall scripts fail, you can manually remove SkyPort.

Troubleshooting

Permission denied

Run the uninstall script using sudo or Administrator privileges.

Service still running

Linux:

terminal
systemctl stop skyport

macOS:

terminal
launchctl unload /Library/LaunchDaemons/in.skyport.server.plist

Windows:

terminal.ps1
taskkill /IM skyport-server.exe /F

PATH still cached

Restart your terminal session after uninstalling.

Data directory still exists

Use:

terminal
SKYPORT_PURGE_DATA=1

during uninstall to fully remove databases and workspace files.

Next:

Introduction

Learn what SkyPort is, what it actually ships, and where to start.

Quick Start

Start SkyPort locally or on a VPS and verify the main workflows.

SkyPort

SkyPort Docs

Self-hosted infrastructure platform