Quick Start Guide

This guide will help you connect your first server to PatchCTL in under 5 minutes.

Prerequisites

Before you begin, ensure you have:

• A PatchCTL account (sign up here)
• A Linux server meeting the system requirements
• SSH access to your server with sudo privileges

Step 1: Get Your License Key

1. Log in to the PatchCTL Dashboard
2. Navigate to Settings → Account
3. Copy your License Key

Keep Your Key Secure

Your license key is like a password. Don't share it publicly or commit it to version control.

Step 2: Install the Agent

SSH into your server and run the installation command:

curl -fsSL https://downloads.patchctl.com/install.sh | sudo bash -s -- --key=YOUR_LICENSE_KEY

Replace YOUR_LICENSE_KEY with the key from Step 1.

What does this command do?

The installation script:

1. Detects your Linux distribution
2. Downloads the appropriate agent binary
3. Creates the /opt/patchctl/ directory structure
4. Configures the agent with your license key
5. Installs and starts the systemd service

Step 3: Verify Installation

Check that the agent is running:

sudo systemctl status patchctl

You should see output indicating the service is active (running):

● patchctl.service - PatchCTL Agent
     Loaded: loaded (/etc/systemd/system/patchctl.service; enabled)
     Active: active (running) since ...

Step 4: Confirm in Dashboard

1. Return to the PatchCTL Dashboard
2. Your server should appear within 5 minutes (the heartbeat interval)
3. Click on the server to view its details

First Heartbeat

The first heartbeat includes a full package scan, so initial data may take a few minutes to populate.

What's Next?

Now that your first server is connected:

• Dashboard Tour - Learn the interface
• Add More Servers - Onboard your fleet
• Create a Schedule - Automate patching
• View CVEs - Check for vulnerabilities

Troubleshooting

Server not appearing in dashboard?

1. Check agent status: sudo systemctl status patchctl
2. View agent logs: sudo journalctl -u patchctl -f
3. Verify network: curl -I https://api.patchctl.com/health
4. Check license key: Ensure the key in /etc/patchctl/config.json is correct

See Troubleshooting for more help.

Installation failed?

Check the Agent Installation guide for distribution-specific instructions and manual installation steps.