DEPLOYMENT6 min read
On-premise Agent
Installing and configuring the Conexor agent on your servers
System Requirements
- .NET 8 Runtime
- Windows Server 2016+ or Linux (Ubuntu 20.04+, Debian 11+)
- Network access to your database
- Outbound HTTPS access to app.conexor.io
Installation
Windows
powershell
# Download the installer Invoke-WebRequest -Uri "https://releases.conexor.io/agent/win-x64/latest" -OutFile "ConexorPlugin.zip" # Extract and run Expand-Archive ConexorPlugin.zip -DestinationPath C:\ConexorPlugin cd C:\ConexorPlugin .\ConexorPlugin.exe # Install as Windows Service (optional) .\ConexorPlugin.exe --install-service
Linux
bash
# Download curl -L https://releases.conexor.io/agent/linux-x64/latest -o conexor-agent.tar.gz tar xzf conexor-agent.tar.gz cd conexor-agent # Run interactively ./ConexorPlugin # Install as systemd service (optional) sudo ./ConexorPlugin --install-service
Configuration
Run the agent interactively first to configure:
text
1. Enter your API key from the Conexor dashboard 2. Add database connections: - Connection name - Database type (SQL Server, PostgreSQL) - Connection string 3. Test each connection 4. Save configuration 5. The agent will connect and start syncing schemas
INFOConfiguration is stored encrypted at ~/.conexor/config.json (Linux) or %APPDATA%\ConexorPlugin\config.json (Windows)
Configuration File
json
{
"apiKey": "pk_live_xxxxx",
"cloudUrl": "https://app.conexor.io",
"connections": [
{
"name": "Production SQL Server",
"type": "SqlServer",
"connectionString": "Server=.;Database=MyApp;Trusted_Connection=true;",
"allowAllQueries": false
}
]
}Service Management
Windows
powershell
# Start service net start ConexorPlugin # Stop service net stop ConexorPlugin # View logs Get-Content "C:\ProgramData\ConexorPlugin\logs\agent.log" -Tail 50 -Wait
Linux
bash
# Start service sudo systemctl start conexor-agent # Stop service sudo systemctl stop conexor-agent # View logs journalctl -u conexor-agent -f
Network Requirements
- Outbound HTTPS (443) to app.conexor.io
- WebSocket connection for real-time communication
- No inbound ports required - uses outbound WebSocket
TIPThe agent works behind firewalls and NAT because it initiates the connection outbound.