Docs / Raw

Administrator Quick Start

Sourced from docs/start/admins.md

Edit on GitHub

Administrator Quick Start

Last Updated: 2025-12-01

This guide covers deployment, configuration, and ongoing administration of VoiceAssist.

Deployment Options

Quick Start (Docker Compose)

# Clone repository
git clone https://github.com/your-org/VoiceAssist.git
cd VoiceAssist

# Configure environment
cp .env.example .env
# Edit .env with your settings

# Start all services
docker-compose up -d

# Verify deployment
curl http://localhost:8000/health

Production Deployment

For production environments, see:

Essential Configuration

Environment Variables

Key variables in .env:

# Database
DATABASE_URL=postgresql://user:pass@localhost:5432/voiceassist

# Redis
REDIS_URL=redis://localhost:6379

# AI Services
OPENAI_API_KEY=sk-...
DEEPGRAM_API_KEY=...
ELEVENLABS_API_KEY=...

# Security
JWT_SECRET=<secure-random-string>
ENCRYPTION_KEY=<32-byte-key>

# Feature Flags
VOICE_MODE_ENABLED=true
THINKER_TALKER_ENABLED=true

For complete configuration reference, see Configuration Reference.

Admin Panel

Accessing Admin Panel

  1. Navigate to https://assist.asimo.io/admin
  2. Log in with admin credentials
  3. You'll see the admin dashboard

Key Sections

SectionPurpose
DashboardSystem health and metrics
UsersUser management and roles
Knowledge BaseDocument upload and indexing
AnalyticsUsage statistics and costs
SettingsSystem configuration

For detailed admin panel documentation, see Admin Panel Specs.

Health Monitoring

Health Endpoints

# Basic health check
curl https://assist.asimo.io/health

# Readiness check
curl https://assist.asimo.io/ready

# Detailed metrics
curl https://assist.asimo.io/metrics

Key Metrics to Monitor

  • Response latency - P95 < 500ms target
  • Error rate - Should be < 1%
  • Voice pipeline latency - First audio < 300ms
  • Database connections - Pool utilization
  • Cache hit rate - Redis effectiveness

Alerting

Configure alerts for:

  • Service downtime
  • High error rates (> 5%)
  • Latency spikes (P95 > 2s)
  • Disk space (< 20% free)
  • Memory usage (> 80%)

User Management

Creating Users

# Via API
curl -X POST https://assist.asimo.io/api/users \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "role": "user"}'

User Roles

RolePermissions
userBasic chat and voice access
adminFull system access
readonlyView-only access

Session Management

  • Sessions expire after 24 hours by default
  • Configure via SESSION_TIMEOUT env var
  • Force logout via admin panel

Knowledge Base Management

Uploading Documents

  1. Go to Admin Panel > Knowledge Base
  2. Click "Upload Documents"
  3. Select PDF or markdown files
  4. Wait for indexing to complete

Via API

curl -X POST https://assist.asimo.io/api/admin/kb/upload \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -F "file=@document.pdf"

Re-indexing

# Trigger full re-index
curl -X POST https://assist.asimo.io/api/admin/kb/reindex \
  -H "Authorization: Bearer $ADMIN_TOKEN"

Backup and Recovery

Database Backups

# Manual backup
pg_dump -h localhost -U postgres voiceassist > backup.sql

# Restore
psql -h localhost -U postgres voiceassist < backup.sql

Automated Backups

Configure via cron or backup service:

# Daily backup at 2 AM
0 2 * * * /opt/scripts/backup-voiceassist.sh

For complete disaster recovery procedures, see Disaster Recovery Runbook.

Security

SSL/TLS

  • All traffic should use HTTPS
  • Certificates via Let's Encrypt or your CA
  • Configure in reverse proxy (nginx/Apache)

API Security

  • JWT tokens for authentication
  • Rate limiting enabled by default
  • CORS configured for allowed origins

Audit Logging

All admin actions are logged:

# View recent admin actions
curl https://assist.asimo.io/api/admin/audit \
  -H "Authorization: Bearer $ADMIN_TOKEN"

For complete security documentation, see Security Compliance.

Troubleshooting

Common Issues

IssueSolution
Service won't startCheck logs: docker-compose logs api-gateway
Database connectionVerify DATABASE_URL and PostgreSQL status
Voice not workingCheck Deepgram/ElevenLabs API keys
Slow responsesCheck Redis cache and AI service latency

Log Locations

# Docker logs
docker-compose logs -f api-gateway

# Application logs
tail -f /var/log/voiceassist/app.log

Getting Help

Maintenance Tasks

Regular Maintenance

TaskFrequencyCommand
Database vacuumWeeklyVACUUM ANALYZE;
Log rotationDailyAutomatic via logrotate
Cache cleanupMonthlyredis-cli FLUSHDB (if needed)
Security updatesWeeklyapt update && apt upgrade

Upgrades

# Pull latest changes
git pull origin main

# Update dependencies
pnpm install

# Run migrations
pnpm db:migrate

# Rebuild and restart
docker-compose build && docker-compose up -d

Key Documentation

Next Steps

  1. Review Production Readiness Checklist
  2. Set up Monitoring & Observability
  3. Configure Backup Procedures
← All documentationHome
Beginning of guide
End of guide