Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.remotemux.com/llms.txt

Use this file to discover all available pages before exploring further.

Use backend=aws when you want the RemoteMux control plane to provision into your own AWS account.

​
What This Backend Does

  1. Authenticates to the RemoteMux control plane with rmux login
  2. Validates your AWS identity and network/storage settings
  3. Creates one EC2 devbox per environment
  4. Uses AWS SSM Session Manager for attach (no inbound port 22 needed)
The control plane owns orchestration and state for the environment lifecycle.

​
Prerequisites

  • AWS credentials (AWS CLI, environment variables, or access keys)
  • AWS Session Manager plugin (bundled in RemoteMux releases)
  • A default VPC in the target region, or explicit subnet and security group settings

​
Configure

The shortest path: 
cd /path/to/project
rmux login
rmux configure --backend aws --from-aws-cli
Explicit configuration: 
rmux configure \
  --backend aws \
  --aws-region us-east-1 \
  --vpc-id vpc-123456 \
  --subnet-ids subnet-a,subnet-b \
  --security-group-ids sg-123 \
  --instance-type t3.large \
  --workspace-bucket my-rmux-bucket

​
Validate

rmux aws-check
Validates the resolved region, credential source, and AWS resources. On the BYOC default path, RemoteMux can auto-discover or create shared defaults (workspace security group, workspace bucket, subnet inputs). To share BYOC settings across a team, enroll them as a provider connection: 
rmux provider connect --label "team-aws"

​
Create and Use

rmux env new
rmux workspace new main
rmux workspace attach

​
Authentication Modes

ModeHow it works
aws-cliUses configured AWS CLI profile. Works with editors and standalone SSH.
envUses AWS_* environment variables. RemoteMux injects credentials for editor commands.
access-keyUses explicit access key ID and secret. RemoteMux injects credentials for editor commands.
rmux configure --backend aws --aws-auth-mode env
rmux configure --backend aws --aws-auth-mode access-key --access-key-id ... --secret-access-key ...

​
Editor Access

Open workspaces in VS Code or Cursor over SSH: 
rmux workspace code main
rmux workspace cursor server
RemoteMux manages SSH entries under ~/.ssh/rmux/config and tunnels through SSM. See Editor Access for details.

​
Port Exposure

AWS BYOC exposed ports currently return direct public-IP URLs such as http://PUBLIC_IP:3000. Private previews and preview share links are currently available only on Managed and E2B environments. BYOC AWS ports stay public until RemoteMux ships a non-public ingress path for that runtime.
Last modified on April 9, 2026