Skip to content

Web Panel

RT Server includes a built-in web-based administration panel that provides a browser interface for managing instances, monitoring performance, and accessing system information without requiring desktop access to the server.

Accessing the Web Panel

The Web Panel is available by default when running RT Server:

  • Default URL: http://server-ip:3546
  • Default Port: 3546 (configurable with --webserver-port)
  • Protocol: HTTP (no authentication required by default)

Network Access

The Web Panel is accessible from any network interface by default. Consider firewall rules or binding to specific interfaces in production environments.

Features

Web Admin

The Web Panel provides:

Instance Management

  • View Running Instances: See all active instances and their status
  • Start/Stop Instances: Control instance lifecycle remotely
  • Instance Configuration: View and modify instance settings
  • Performance Metrics: Monitor CPU, memory, and processing statistics

System Information

  • Engine Version: CVEDIA-RT version and build information
  • CPU Information: Processor model and architecture details
  • Web Panel Version: Current Web Panel interface version
  • Log Access: View recent log entries

License Management

  • View License Information: See active licenses and their status
  • Activate License: Enter a new license key
  • Deactivate License: Remove an existing license

REST API Testing

  • Interactive API Documentation: Test REST endpoints directly from the browser
  • Request Builder: Construct and send API requests
  • Response Viewer: Examine API responses and data formats

Configuration

Port and Binding

Configure the Web Panel through command line options:

# Change port
rtservice --webserver-port 8080

# Bind to specific interface
rtservice --webserver-host 127.0.0.1 --webserver-port 3546

# Disable web panel
rtservice --no-webserver

Docker Configuration

When running in Docker, ensure ports are properly exposed:

# Expose Web Panel port
./run.sh --daemon --api_port 3546

# Custom port mapping
./run.sh --daemon -- -p 8080:3546

rtconfig.json Configuration

Web Panel settings can be configured in the global configuration:

{
  "webserver": {
    "enabled": true,
    "port": 3546,
    "host": "0.0.0.0",
    "cors_enabled": true,
    "api_docs_enabled": true
  }
}

Usage

Instance Operations

  1. Viewing Instances

    • Navigate to the Instances section
    • View instance status, uptime, and basic metrics
    • Click on instances for detailed information

  2. Starting/Stopping Instances

    • Use control buttons next to each instance
    • Monitor state changes in real-time
    • View startup/shutdown logs

  3. Configuration Changes

    • Access instance configuration through the interface
    • Modify settings and apply changes
    • Restart instances to apply configuration

API Testing

  1. REST Endpoints

    • Browse available API endpoints
    • View endpoint documentation
    • Test requests with sample data

  2. Response Analysis

    • Examine JSON responses
    • Validate data formats
    • Debug API integration issues

Security Considerations

Network Security

  • Firewall Rules: Restrict access to Web Panel port
  • VPN Access: Use VPN for remote administration
  • Local Binding: Bind to localhost for local-only access

Access Control

Currently, the Web Panel does not include built-in authentication. For production deployments:

  • Use reverse proxy with authentication (nginx, Apache)
  • Implement network-level access controls
  • Consider VPN or SSH tunneling for remote access

Troubleshooting

Web Panel Not Accessible

  1. Check Service Status

    # Verify RT Server is running
ps aux | grep rtservice
# or for Docker
docker ps | grep cvedia-rt

  2. Verify Port Configuration

    # Check if port is listening
netstat -tlnp | grep 3546

  3. Check Firewall Rules

    # Linux firewall check
ufw status
iptables -L

Web Panel Loads but Shows Errors

  1. Check RT Server Logs

    • Look for webserver startup messages
    • Verify no port conflicts exist
    • Check for plugin loading errors

  2. Browser Console

    • Open browser developer tools
    • Check for JavaScript errors
    • Verify network connectivity

Limitations

RT Studio Compatibility

The Web Panel only works with RT Server (rtservice). Instances created through the Web Panel or REST API, should not be modified through RT Studio (rtstudio). RT Studio modifies instance metadata in ways that are not compatible with the Web Panel.

Next Steps