sipstack/connector-asterisk repository overview

-- Create connector user with read access
CREATE USER 'asterisk_reader'@'%' IDENTIFIED BY 'secure_password';
GRANT SELECT ON asterisk.cdr TO 'asterisk_reader'@'%';
GRANT SELECT ON asterisk.cel TO 'asterisk_reader'@'%';
FLUSH PRIVILEGES;

-- Allow Docker network access (adjust IP range as needed)
-- For Docker bridge: 172.17.0.0/16
-- For custom networks: check with 'docker network ls'

-- Create connector user
CREATE USER asterisk_reader WITH PASSWORD 'secure_password';
GRANT SELECT ON TABLE cdr TO asterisk_reader;
GRANT SELECT ON TABLE cel TO asterisk_reader;

host asterisk asterisk_reader 172.17.0.0/16 md5

version: '3.8'
services:
  asterisk-connector:
    image: sipstack/asterisk-connector:latest
    container_name: asterisk-connector
    restart: unless-stopped
    env_file: .env
    volumes:
      # Optional: For recording detection
      - /var/spool/asterisk/monitor:/var/spool/asterisk/monitor:ro
      - /var/log/asterisk:/var/log/asterisk:ro

# API Configuration
API_KEY=sk_your_api_key_here
REGION=us1
CUSTOMER_ID=123

# Database Connection
DB_TYPE=mysql
DB_HOST=172.17.0.1
DB_PORT=3306
DB_NAME=asterisk
DB_USER=asterisk_reader
DB_PASSWORD=secure_password

# CEL Configuration (choose one)
CEL_MODE=db
# OR for CSV: CEL_MODE=csv

# Call Shipping (optional)
CALL_SHIPPING_MODE=complete
LONG_CALL_UPDATE_INTERVAL=600

docker-compose up -d

docker run -d \
  --name asterisk-connector \
  --restart unless-stopped \
  --env-file .env \
  -v /var/spool/asterisk/monitor:/var/spool/asterisk/monitor:ro \
  -v /var/log/asterisk:/var/log/asterisk:ro \
  sipstack/asterisk-connector:latest

# Docker Compose
docker-compose logs -f

# Docker Run
docker logs -f asterisk-connector

API_KEY=sk_xxxxx                    # Your SIPSTACK API key
REGION=us1                          # us1, us2, ca1, or dev
CUSTOMER_ID=123                     # Your customer ID
TENANT=                             # Optional default tenant

DB_TYPE=mysql                       # mysql or postgresql
DB_HOST=172.17.0.1                  # Database host (Docker gateway)
DB_PORT=3306                        # 3306 for MySQL, 5432 for PostgreSQL
DB_NAME=asterisk                    # Database name
DB_USER=asterisk_reader             # Database user
DB_PASSWORD=secure_password         # Database password

# Option 1: Database CEL (requires cel_odbc module)
CEL_MODE=db
DB_TABLE_CEL=cel

# Option 2: CSV CEL (requires cel_custom module)
CEL_MODE=csv
CEL_CSV_PATH=/var/log/asterisk/cel-custom/Master.csv

# Option 3: AMI CEL (requires cel_manager module)
CEL_MODE=ami
AMI_HOST=asterisk.local
AMI_PORT=5038
AMI_USERNAME=manager
AMI_PASSWORD=secret

CALL_SHIPPING_MODE=complete         # complete or progressive
LONG_CALL_UPDATE_INTERVAL=600       # Update long calls every N seconds

RECORDING_ENABLED=true
RECORDING_PATHS=/var/spool/asterisk/monitor,/var/spool/asterisk/recordings
DB_TABLE_RECORDINGS=                # Optional recordings table

# Find your Docker gateway
docker network inspect bridge | grep Gateway
# Use that IP in DB_HOST (usually 172.17.0.1)

docker run --network host ...
# Then use DB_HOST=localhost

# Use DB_HOST=host.docker.internal

# Test from container
docker exec -it asterisk-connector python3 -c "
import pymysql
conn = pymysql.connect(host='172.17.0.1', user='asterisk_reader', password='secure_password', database='asterisk')
print('Database connection successful')
"