Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyberdesk.io/llms.txt

Use this file to discover all available pages before exploring further.

Cyberdriver connects outbound to Cyberdesk over HTTPS/WebSocket. Some organizations need that traffic to go through a company-controlled domain for firewall allowlisting or traffic inspection.

​
Requirements

Your proxy must support long-lived WebSocket connections:
  • HTTP Upgrade headers
  • bidirectional streaming
  • long idle timeouts, ideally 24 hours
  • TLS to the public Cyberdesk endpoint

​
Nginx example

server {
    listen 443 ssl;
    server_name automation.yourcompany.com;

    ssl_certificate     /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;

    location / {
        proxy_pass https://api.cyberdesk.io;
        proxy_ssl_server_name on;
        proxy_set_header Host api.cyberdesk.io;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_read_timeout 86400s;
        proxy_send_timeout 86400s;
    }
}

​
Configure Cyberdriver

For CLI installs: 
$Cyberdriver = (Get-Command Cyberdriver.exe -ErrorAction Stop).Source
& $Cyberdriver join --secret YOUR_API_KEY --api-base https://automation.yourcompany.com
For the Windows MSI flow, use the normal Cyberdriver settings unless the Cyberdesk team gives you a custom host value.