Install the Plugin

The conexor.io plugin runs on your infrastructure and acts as a secure bridge between your databases and the cloud platform. No inbound firewall rules needed.

Overview

The plugin is a lightweight self-contained binary (no runtime required) that connects outbound to conexor.io over WSS (WebSocket Secure) on port 443. Your database credentials are encrypted locally and never leave your network in plaintext.

Option 1: One-line installer (Linux, recommended)

The fastest way. Downloads the binary, writes your config, and installs a systemd service — automatically. Get your API key from Dashboard → Plugins → New Plugin.

curl -sSL https://app.conexor.io/install-plugin.sh | sudo bash -s -- --api-key YOUR_API_KEY

That's it. The installer will:

• Download the latest plugin binary for your architecture (x64 or arm64)
• Verify the SHA-256 checksum
• Write configuration to /etc/conexor-plugin/config.json
• Install and start a systemd service that auto-restarts on failure
• Verify the plugin connected to conexor.io

# View live logs
sudo journalctl -u conexor-plugin -f

# Check service status
sudo systemctl status conexor-plugin

Option 2: Docker

Run the plugin as a container. Mount a config directory for persistent settings.

docker run -d \
  --name conexor-plugin \
  --restart unless-stopped \
  -v /etc/conexor-plugin:/config \
  conexorio/plugin:latest

services:
  conexor-plugin:
    image: conexorio/plugin:latest
    restart: unless-stopped
    volumes:
      - /etc/conexor-plugin:/config
    # Optional: give the container access to local databases
    network_mode: host

Option 3: Binary (manual)

Download the self-contained binary and run it directly. No .NET runtime required.

# Download binary
curl -sSfL "https://app.conexor.io/api/plugin/releases/latest/download?platform=linux-x64" \
  -o /usr/local/bin/conexorio-plugin
chmod +x /usr/local/bin/conexorio-plugin

# Run setup wizard (interactive)
sudo conexorio-plugin --setup

# Download from the dashboard: Dashboard → Plugins → Download
# Or via PowerShell:
Invoke-WebRequest -Uri "https://app.conexor.io/api/plugin/releases/latest/download?platform=win-x64" \
  -OutFile conexorio-plugin.exe

# Run setup wizard (as Administrator)
.\conexorio-plugin.exe --setup

Configuration file

The plugin reads its configuration from config.json in the config directory (/etc/conexor-plugin/ by default, or set via --config-dir).

{
  "PluginName": "prod-server",
  "ApiKey": "pk_your_api_key_here",
  "CloudHubUrl": "https://app.conexor.io/hubs/plugin"
}

Service management (Linux)

# Start / stop / restart
sudo systemctl start conexor-plugin
sudo systemctl stop conexor-plugin
sudo systemctl restart conexor-plugin

# View logs
sudo journalctl -u conexor-plugin -f

# Disable auto-start on boot
sudo systemctl disable conexor-plugin

Auto-updates

The plugin checks for updates every 24 hours and applies them automatically with a service restart. You can also check and apply updates manually:

sudo conexorio-plugin --setup
# Select: 4. Check for updates

Verify the connection

After starting the plugin, check the dashboard — the plugin card should show a green Online badge within 30 seconds.

sudo journalctl -u conexor-plugin --since "1 minute ago" --no-pager

# Expected output:
# [INFO] Plugin starting...
# [INFO] Connecting to cloud hub...
# [INFO] Plugin registered successfully
# [INFO] Heartbeat interval: 30s