Getting started¶
This section walks you through standing up a new Waveshift deployment in your AWS account. Two paths are documented:
- Deploy walkthrough — the full
step-by-step walkthrough, including AWS prerequisites, what
wsctlcreates, and post-deploy verification. Read this on the first deployment. - Quick deploy — the short version: the commands and TUI steps only, plus the default credentials. Use this when you've done it before.
What you'll have at the end¶
A v0.5 Waveshift deployment running in your own AWS account:
- Orchestrator EC2 instance running the Web Console at
https://console.waveshift.internal(or whichever private domain you chose). - Optional Kasm Workspaces host at
https://workspaces.waveshift.internal. - An admin user account ready to issue regular users, sites, and WireGuard Egress Servers from the Console.
The Console and Kasm are reachable only over the WireGuard network — the orchestrator never exposes a public HTTPS endpoint. You connect to it via a configured Hub, a Node, or a direct WireGuard client config from an Infrastructure Server.
Prerequisites¶
Before you start, you need:
- An AWS account that's been authorised by Blackfire Technology. Bootstrap permissions need to cover EC2, IAM, Route 53, S3, SSM, and VPC for the initial deploy.
- The AWS CLI with a profile configured for that account.
- The AWS Session Manager Plugin for SSM-backed shells from
wsctl. - The
wsctlbinary on yourPATH— see Install wsctl. - An identity account identifier issued to you by Blackfire Technology. This is the GCP-side workload identity used to federate your AWS account; you'll be told what to pass when you're onboarded.
wsctl creates a private Route 53 hosted zone for the
deployment using a domain name you choose during the TUI (default
waveshift.internal). It only resolves inside the WireGuard
network, so you don't need to own the domain publicly — the
default works fine for most deployments.
That's it for cloud-only deployments. If you're running with hardware nodes you'll also need a Waveshift hardware kit; see Hardware Setup before configuring a Site / Hub.
Where to next¶
- New here → Deploy walkthrough.
- Already deployed → Console tour or CLI reference.
- Hit something unexpected → Common issues.