Konradodocs

How the Konrado plugin works

What the Konrado plugin installs on a cPanel, Plesk, DirectAdmin, Proxmox or SolusVM 2 server, and how the installer works.

The Konrado plugin is the legacy way to connect a server. Servers already connected with it keep working. For a new server, use the panel's own API: open the page for your panel below and pick the API tab.

The Konrado plugin runs on your server and answers Konrado's lookups from there. You run one command as root. On cPanel and DirectAdmin it reads more than the API: the firewall (CSF), CloudLinux and Imunify, where the server has them. The pages for each panel cover both ways:

What gets installed

PartWhere
The plugin and its own Python/opt/KonradoAi
A system user and groupkonrado.ai
Two serviceskonrado-server and konrado-root
Settings/opt/KonradoAi/.env
Port8000, unless you choose another

Konrado calls the plugin on that port, so open it to Konrado's IP addresses and to no one else.

The install command

The console builds the command with your key and the --platform of the panel you picked:

bash <(curl -s https://repo.konrado.ai/init.sh) --api-key=YOUR_KEY --callback-url=https://app.konrado.ai/api/integrations/servers/install --platform=cpanel
Panel--platform
cPanelcpanel
Pleskplesk
DirectAdmindirectadmin
Proxmoxproxmox
SolusVM 2solus

The key works for 24 hours, on as many servers as you like. Within those 24 hours, the same command run again on the same server updates that server's row instead of adding one, and sets its name back to the default, such as cpanel Server. A command with a newer key adds a new row. Copy the command from the console, not from here.

What the installer asks

The installer needs root, curl, unzip and systemd. It brings its own Python when the server has no Python 3.10 or newer. Then it asks for a few settings. Press Enter to keep each default.

QuestionDefaultWhat it is
SERVER_BIND_IP_ADDRESS0.0.0.0The address the plugin listens on
SERVER_PORT8000The port Konrado calls
SOCKET_PATH/var/run/konrado.ai.sockHow the two services talk to each other
MODULESDepends on the panelWhich lookups the plugin offers
Do you want to be able to upgrade this plugin through the Konrado panel?YesYes lets you update it from the console
SOLUSVM2_URL and SOLUSVM2_API_TOKENYour server's IP, no tokenSolusVM 2 only: the panel's address and an API token
Enter server IP address or hostnamehttp://<public IP>:8000/mcpThe address Konrado uses to reach the plugin

The plugin creates its own API key and sends it to Konrado with the server address. You never type it.

Manage it later

Last updated on

On this page