Skip to content

Under Construction

This section is currently being developed and may be incomplete/outdated.

User Guide Introduction

This user guide provides documentation for deploying and operating Waveshift using the wavectl CLI tool.

What's Covered

System Architecture

Understanding how Waveshift works:

Key Concepts

Deployment Workflow

Understanding how Waveshift deployment works:

  1. Deploy Infrastructure: Use wavectl deploy to create AWS resources
  2. Add Sites: Use wavectl sites to register physical locations
  3. Configure Routers: Use wavectl configure-hub to set up GL.iNet routers
  4. Monitor Health: Use wavectl health-check to verify system status

Site Management

Waveshift connects physical locations (sites) through:

  • WireGuard VPN: Encrypted site-to-site communication
  • GL.iNet Routers: Hub devices that connect sites to the platform
  • Device Discovery: Automatic detection of devices on site networks

Infrastructure Components

The deployed system includes:

  • Waveshift Platform: Core services running on AWS EC2
  • Kasm Workspaces: Containerized desktop environments
  • VPC Networking: Secure private network infrastructure
  • Route53 DNS: Internal domain resolution

Common Operations

Initial Deployment

  1. Configure AWS credentials
  2. Deploy infrastructure with wavectl deploy
  3. Wait for services to be ready
  4. Add sites for physical locations
  5. Configure router hubs

Site Operations

  1. Register new sites with the platform
  2. Configure GL.iNet routers as hubs
  3. Monitor site connectivity
  4. Troubleshoot network issues

System Maintenance

  1. Monitor system health regularly
  2. Update router configurations as needed
  3. Review deployment logs
  4. Manage AWS resources

Getting Help

If you need assistance:

  1. Check Documentation: Review the CLI reference and troubleshooting guides
  2. Use Health Checks: Run wavectl health-check to diagnose issues
  3. Review Logs: Check deployment and configuration logs
  4. Troubleshooting: See troubleshooting guides
  5. Support: Contact Blackfire Technology support

Next Steps