Cgi Mode

CGI Mode

Deploy agents as CGI scripts on traditional web servers like Apache or nginx. The SDK automatically detects CGI environments and handles requests appropriately.

CGI Overview

CGI (Common Gateway Interface) allows web servers to execute scripts and return their output as HTTP responses.

Benefits:

• Works with shared hosting
• Simple deployment - just upload files
• No separate process management
• Compatible with Apache, nginx

Drawbacks:

• New process per request (slower)
• No persistent connections
• Limited scalability

CGI Detection

The SDK detects CGI mode via the GATEWAY_INTERFACE environment variable:

1
## Automatic detection
2
if os.getenv('GATEWAY_INTERFACE'):
3
    # CGI mode detected
4
    mode = 'cgi'

Basic CGI Script

1
#!/usr/bin/env python3
2
## agent.py - Basic CGI agent script
3
from signalwire_agents import AgentBase
4
5
6
class MyAgent(AgentBase):
7
    def __init__(self):
8
        super().__init__(name="my-agent")
9
        self.add_language("English", "en-US", "rime.spore")
10
        self.prompt_add_section("Role", "You are a helpful assistant.")
11
12
13
if __name__ == "__main__":
14
    agent = MyAgent()
15
    agent.run()  # Automatically detects CGI mode

Make it executable:

$
chmod +x agent.py

CGI Request Flow

Apache Configuration

Enable CGI

1
## Enable CGI module
2
LoadModule cgi_module modules/mod_cgi.so
3
4
## Configure CGI directory
5
<Directory "/var/www/cgi-bin">
6
    Options +ExecCGI
7
    AddHandler cgi-script .py
8
    Require all granted
9
</Directory>

Virtual Host Configuration

1
<VirtualHost *:443>
2
    ServerName agent.example.com
3
4
    SSLEngine on
5
    SSLCertificateFile /etc/ssl/certs/agent.crt
6
    SSLCertificateKeyFile /etc/ssl/private/agent.key
7
8
    ScriptAlias / /var/www/cgi-bin/agent.py
9
10
    <Directory "/var/www/cgi-bin">
11
        Options +ExecCGI
12
        SetHandler cgi-script
13
        Require all granted
14
    </Directory>
15
16
    # Set environment variables
17
    SetEnv SWML_BASIC_AUTH_USER "myuser"
18
    SetEnv SWML_BASIC_AUTH_PASSWORD "mypassword"
19
</VirtualHost>

nginx Configuration

nginx doesn’t natively support CGI, but you can use FastCGI with fcgiwrap:

1
server {
2
    listen 443 ssl;
3
    server_name agent.example.com;
4
5
    ssl_certificate /etc/ssl/certs/agent.crt;
6
    ssl_certificate_key /etc/ssl/private/agent.key;
7
8
    location / {
9
        fastcgi_pass unix:/var/run/fcgiwrap.socket;
10
        fastcgi_param SCRIPT_FILENAME /var/www/cgi-bin/agent.py;
11
        fastcgi_param GATEWAY_INTERFACE CGI/1.1;
12
        fastcgi_param PATH_INFO $uri;
13
        fastcgi_param SWML_BASIC_AUTH_USER "myuser";
14
        fastcgi_param SWML_BASIC_AUTH_PASSWORD "mypassword";
15
        include fastcgi_params;
16
    }
17
}

CGI Host Configuration

In CGI mode, the SDK needs to know the external hostname for generating URLs:

$
## Using swaig-test to simulate CGI mode
$
swaig-test my_agent.py --simulate-serverless cgi --cgi-host agent.example.com

Or set environment variable:

1
SetEnv SWML_PROXY_URL_BASE "https://agent.example.com"

Testing CGI Locally

Use swaig-test to simulate CGI environment:

$
## Test SWML generation in CGI mode
$
swaig-test my_agent.py --simulate-serverless cgi --dump-swml
$
$
## With custom host
$
swaig-test my_agent.py --simulate-serverless cgi --cgi-host mysite.com --dump-swml
$
$
## Test a function
$
swaig-test my_agent.py --simulate-serverless cgi --exec function_name --param value

Authentication in CGI Mode

The SDK checks basic auth in CGI mode:

1
## Authentication is automatic when these are set
2
## SWML_BASIC_AUTH_USER
3
## SWML_BASIC_AUTH_PASSWORD
4
5
## The SDK reads Authorization header and validates

If authentication fails, returns 401 with WWW-Authenticate header.

Directory Structure

Shared Hosting Deployment

For shared hosting where you can’t install system packages:

1
#!/usr/bin/env python3
2
## agent_shared.py - CGI agent for shared hosting
3
import sys
4
import os
5
6
## Add local packages directory
7
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'packages'))
8
9
from signalwire_agents import AgentBase
10
11
12
class MyAgent(AgentBase):
13
    def __init__(self):
14
        super().__init__(name="my-agent")
15
        self.add_language("English", "en-US", "rime.spore")
16
17
18
if __name__ == "__main__":
19
    agent = MyAgent()
20
    agent.run()

Install packages locally:

$
pip install --target=./packages signalwire-agents

CGI Best Practices

Performance

• Keep imports minimal - each request starts fresh
• Consider FastCGI for better performance
• Cache what you can (but remember process dies)

Security

• Set proper file permissions (750 or 755)
• Don’t expose .py files directly if possible
• Use HTTPS always
• Set auth credentials as environment variables

Debugging

• Check web server error logs
• Verify shebang line (#!/usr/bin/env python3)
• Test script from command line first
• Ensure proper line endings (LF, not CRLF)

Common CGI Issues

Migration from CGI

When you outgrow CGI:

CGI → FastCGI

Keep same code, use fcgiwrap or gunicorn. Better performance, persistent processes.

CGI → Server Mode

Same code works - just run differently (python agent.py instead of CGI). Add systemd service, nginx reverse proxy.

CGI → Serverless

Same code works with minor changes. Add Lambda handler wrapper. Deploy to AWS/GCP/Azure.