Installation

Picking a Server OS

Skyport runs on a wide range of operating systems, so pick whichever you are most comfortable using.

Operating System	Version	Supported	Notes
Ubuntu	24.04	✅	Documentation written assuming Ubuntu 24.04 as the OS.
	22.04	✅
CentOS	7	✅	Extra repos are required.
	8	✅	Note that CentOS 8 is EOL. Use Rocky or Alma Linux.
Debian	11	✅
	12	✅
Windows	11	⚠️	Support is very limited due to Docker's use of WSL (and LinuxKit VMs on Mac) on the Windows and macOS operating systems. You will have issues connecting to instances ran on a machine with either OS. You'll only have issues with Skyport Daemon - the Panel will work just fine.
	10	⚠️
macOS	10.15+	⚠️

Dependencies

Node.js v20 and higher (Nodejs v20 recommended).

Example Dependency Installation

The commands below are simply an example of how you might install these dependencies on Ubuntu 24.04. Please consult with your operating system's package manager to determine the correct packages to install.

# Ubuntu/Debian
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list

sudo apt update
sudo apt install -y nodejs git

Installation

The following commands will download the Skyport Panel into /etc/skyport and use npm to install the required packages:

cd /etc

For the Last stable use this:

git clone --branch v0.2.2 https://github.com/skyportlabs/panel

If you want the latests main branch use

git clone https://github.com/skyportlabs/panel

Afther chosing what you want to use do following commands

mv panel skyport
cd skyport
npm install

Seed & Create a User

You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.

npm run seed
npm run createUser

Setup Complete

All you need to do now is start Skyport:

node .

Your Panel will now be accessible from port 3001 (unless you changed it in config.json).