Getting Started
Quick Start
Get SkyPort running in 5 minutes
Get SkyPort up and running in just a few minutes.
1. Install SkyPort
If you haven't already, install SkyPort for your platform.
Verify the installation:
skyport --version
2. Start the Server
Start the SkyPort web dashboard:
skyport start webui
You should see output like:
_____ _ ______ _
/ ____| | | ____| | |
| (___ | | ___ _| |__ ___ _ __ | |_
\___ \| |/ / | | | __/ / _ \| '__| __|
____) | <| |_| | | | (_) | | | |_
|_____/|_|\_\\__,_|_| \___/|_| \__|
v1.0.0 - Self-Hosted Infrastructure Platform
Starting SkyPort WebUI on http://localhost:8080
3. Access the Dashboard
Open your browser and go to: http://localhost:8080
You'll see the SkyPort dashboard with:
- Overview of your system
- Docker containers
- PM2 processes
- System resources
4. Configure Your First Connection
Option A: Local Machine
If running SkyPort on your local machine, it automatically detects:
- Docker installation
- PM2 installations
- System resources
No configuration needed!
Option B: Remote Server
To connect to a remote server:
- Click "Add Server" in the dashboard
- Enter server details:
- Hostname or IP address
- SSH username
- SSH port (default: 22)
- Authentication method (key or password)
- Click "Connect"
- SkyPort will detect available services
5. Deploy Your First App
Option A: Using Docker
# Pull an image
skyport docker pull nginx:latest
# Run it
skyport docker run -d -p 8000:80 --name webserver nginx:latest
# Check it's running
skyport docker ps
Visit http://localhost:8000 to see your running app!
Option B: Using PM2
If you have a Node.js application:
# Start the app with PM2
skyport pm2 start app.js --name "my-app"
# Check status
skyport pm2 list
# View logs
skyport pm2 logs my-app
Option C: From Marketplace
Browse pre-built applications:
# Search for apps
skyport marketplace search
# Install one
skyport marketplace install postgres
# View installed apps
skyport marketplace list
6. Explore the CLI
SkyPort has powerful CLI commands for automation:
# Get help
skyport help
# View docker commands
skyport docker help
# View PM2 commands
skyport pm2 help
# View VPS commands
skyport vps help
# View logs
skyport logs app-name -f
7. Access the Terminal UI (Optional)
For a real-time terminal dashboard:
skyport start tui
This gives you a beautiful terminal UI showing:
- System metrics
- Running containers
- Processes
- Logs
- Terminal access
Common Tasks
View System Status
# Dashboard overview
skyport status
# Detailed system info
skyport system info
# Resource usage
skyport metrics
Manage Applications
# Docker
skyport docker ps
skyport docker logs container-name -f
skyport docker restart container-name
# PM2
skyport pm2 list
skyport pm2 logs app-name
skyport pm2 restart app-name
View Logs
# Follow logs
skyport logs service-name -f
# View last 100 lines
skyport logs service-name --lines 100
# Search logs
skyport logs service-name --grep "error"
Stop SkyPort
To stop the SkyPort server:
# Press Ctrl+C in the terminal
# or
skyport stop
Next Steps
- Read Installation Guide for detailed setup
- Explore Docker Management
- Learn about PM2 Processes
- Check CLI Documentation
- View Deployment Guide
Need help? Check the Troubleshooting Guide