Help & Setup

No Server

Quick Setup Guide

Connect your servers and personal computers to NebulaOps in minutes. Choose automatic setup or follow the manual guides below.

Automatic Agent Installation
Download and run the installer to automatically connect your computer to NebulaOps.
desktop_windows
Windows
PowerShell Script
terminal
Linux
Bash Script
laptop_mac
macOS
Bash Script
Preparing Download...
Your installer is being generated
hourglass_empty
Download installer script
hourglass_empty
Run as Administrator (Windows) or with sudo (Linux/Mac)
hourglass_empty
Wait for installation to complete
hourglass_empty
Your device appears in the server list!
network_check Connection Diagnostics
dns
Server Status
Not tested
cable
WebSocket Endpoint
Not tested
devices
Connected Agents
Not tested
speed
Response Time
Not tested

play_circle Interactive Tutorials

play_arrow
Windows: Auto Agent Setup
schedule 4 steps
play_arrow
Linux/Mac: Auto Agent Setup
schedule 4 steps
play_arrow
Connect Linux Server via SSH
schedule 5 steps
play_arrow
Proxmox VE Integration
schedule 5 steps

menu_book Connection Guides

laptop
Auto Agent (Recommended)
Windows, Linux, macOS
  1. Enter a name for your device in the field above
  2. Download the installer for your operating system
  3. Run the script:
    Windows: Right-click → Run with PowerShell Linux/Mac: chmod +x install.sh && sudo ./install.sh
  4. Done! Your device will appear in the server list automatically
terminal
Linux Server (SSH)
Ubuntu, Debian, CentOS, etc.
  1. Ensure SSH is installed on your server:
    sudo apt install openssh-server -y sudo systemctl enable ssh && sudo systemctl start ssh
  2. Get your server's IP address:
    ip addr show | grep inet
  3. Add in NebulaOps: Click "Add Server" in the sidebar, select "Linux (SSH)", enter hostname, username, and authentication method
  4. For SSH key auth: Copy the NebulaOps public key to your server's ~/.ssh/authorized_keys
desktop_windows
Windows Server (SSH)
Windows 10/11, Server 2019+
  1. Enable OpenSSH Server in Windows:
    Add-WindowsCapability -Online -Name OpenSSH.Server* Start-Service sshd Set-Service -Name sshd -StartupType Automatic
  2. Allow SSH through firewall:
    New-NetFirewallRule -Name sshd -DisplayName 'OpenSSH' -Enabled True -Direction Inbound -Protocol TCP -Action Allow -LocalPort 22
  3. Add in NebulaOps: Select "Windows (SSH)", enter the hostname and your Windows username/password
settings_remote
Windows Server (WinRM)
Windows Remote Management
  1. Enable WinRM on Windows (Run as Admin):
    winrm quickconfig -y winrm set winrm/config/service '@{AllowUnencrypted="true"}' winrm set winrm/config/service/auth '@{Basic="true"}'
  2. For HTTPS (recommended): Create a self-signed certificate and configure WinRM to use it
  3. Add in NebulaOps: Select "Windows (WinRM)", use port 5985 (HTTP) or 5986 (HTTPS), choose NTLM authentication
memory
Proxmox VE
Virtual Environment
  1. Get API credentials: In Proxmox web UI, go to Datacenter → API Tokens → Add
  2. Create a token with appropriate permissions (VM.Audit, VM.PowerMgmt, etc.)
  3. Note the Token ID (format: user@realm!tokenid) and the secret
  4. Add in NebulaOps: Select "Proxmox VE", enter host (e.g., 192.168.1.100:8006), use token as username and secret as password
deployed_code
Docker Management
Manage containers remotely
  1. Connect your server using any method above (SSH recommended)
  2. Ensure Docker is installed:
    curl -fsSL https://get.docker.com | sh sudo usermod -aG docker $USER
  3. Navigate to Docker page in NebulaOps sidebar
  4. Select your server to view and manage containers, images, networks, and volumes

help Frequently Asked Questions

What's the difference between Agent and SSH connection? expand_more
Agent: Installs a small program on your device that connects back to NebulaOps. Best for personal computers, laptops, and devices behind firewalls. No need to open ports.

SSH: Direct connection to your server using SSH protocol. Best for servers with static IPs. Requires SSH access to be enabled and port 22 open.
Is the Agent secure? expand_more
Yes! The agent connects to NebulaOps using secure WebSocket (WSS) encryption. It only executes commands that you send through the authenticated NebulaOps interface. The agent doesn't open any ports on your device.
Can I connect devices behind NAT/firewall? expand_more
Yes! The Agent method is perfect for this. Since the agent initiates an outbound connection to NebulaOps, it works through firewalls and NAT without needing to open any incoming ports.
How do I uninstall the Agent? expand_more
Windows: Run PowerShell as Administrator:
Unregister-ScheduledTask -TaskName 'NebulaOpsAgent' -Confirm:$false
Remove-Item -Recurse -Force "$env:ProgramData\NebulaOps"

Linux/Mac:
sudo systemctl stop nebulaops-agent && sudo systemctl disable nebulaops-agent
sudo rm /etc/systemd/system/nebulaops-agent.service
sudo rm -rf /opt/nebulaops
What ports need to be open? expand_more
Agent: No incoming ports needed. Only outbound HTTPS (443).
SSH: Port 22 (or custom SSH port)
WinRM: Port 5985 (HTTP) or 5986 (HTTPS)
Proxmox: Port 8006 (HTTPS)
Agent installed but not showing in server list? expand_more
Troubleshooting steps:

1. Check if the agent is running:
Windows: Get-ScheduledTask -TaskName "NebulaOpsAgent" | Get-ScheduledTaskInfo
Linux: sudo systemctl status nebulaops-agent

2. View agent logs:
Windows: type %ProgramData%\NebulaOps\agent.log
Linux: sudo journalctl -u nebulaops-agent -f

3. Common issues:
• Connection refused: Check if NebulaOps server is reachable from agent device
• SSL errors: The agent now handles self-signed certificates automatically
• Firewall blocking: Ensure outbound HTTPS (443) is allowed
• Wrong URL: Verify the WebSocket URL in the agent script matches your server

4. Manual test connection:
Windows: Test-NetConnection nebulaops.yourserver.com -Port 443
Linux: curl -I https://nebulaops.yourserver.com
How do I check the agent status? expand_more
Windows:
Get-ScheduledTask -TaskName "NebulaOpsAgent" | Format-List
type %ProgramData%\NebulaOps\agent.log

Linux/Mac:
sudo systemctl status nebulaops-agent
sudo journalctl -u nebulaops-agent --since "1 hour ago"

You can also check the sidebar in NebulaOps - connected agents show with a green dot and "(Agent)" label.
Can I reinstall or update the agent? expand_more
Yes! Simply download a new installer with the same device name and run it. The installer will:
• Stop the existing agent
• Update the agent script
• Restart the agent with the new configuration

Your device will reconnect automatically with the same name.

build Quick Troubleshooting

error
Connection Issues
Agent can't connect
  1. Verify the server URL is accessible from agent device
  2. Check firewall allows outbound HTTPS (port 443)
  3. Ensure the agent service is running
  4. Look at agent logs for specific error messages
warning
Agent Shows Offline
Was connected, now offline
  1. Device may have gone to sleep or lost network
  2. Agent will auto-reconnect when device is back online
  3. Check if scheduled task/service is still enabled
  4. Restart the agent service if needed
vpn_key
SSH Authentication Failed
Permission denied errors
  1. Verify username and password are correct
  2. Check if SSH service is running on target server
  3. Ensure port 22 is open and not blocked by firewall
  4. Try connecting with ssh user@host from terminal
tips_and_updates
Best Practices
Tips for optimal usage
  1. Use unique names for each device to easily identify them
  2. Agent method is preferred for devices behind NAT/firewall
  3. SSH method is better for servers with static IPs
  4. Regularly check the dashboard for device health

keyboard Keyboard Shortcuts

Dashboard
Toggle theme Ctrl + Shift + T
Quick search Ctrl + K
Refresh data Ctrl + R
Terminal
Clear terminal Ctrl + L
Cancel command Ctrl + C
Previous command Up Arrow
Tutorials
Next step Right Arrow
Previous step Left Arrow
Close tutorial Esc

lightbulb Quick Tips

rocket_launch Quick Start

For the fastest setup, use the Agent installer. Just enter a device name, download the script, and run it. Your device will connect automatically within seconds!

security Security First

All connections are encrypted. The agent uses secure WebSocket (WSS), and SSH connections support both password and key-based authentication.

support_agent Need Help?

Use the Connection Diagnostics tool above to check your server status. If issues persist, check the FAQ section or review the agent logs on your device.

Tutorial