Deployment Documentation¶
Deployment strategies, environment configuration, and operational procedures for the ShadowHound system across development and production environments.
Overview¶
This directory contains guides for deploying and operating ShadowHound across multiple machines (laptop, Thor/Jetson, GO2 robot) with different environment configurations.
Documents¶
Environment Strategy¶
- Codex Environment Strategy - Environment configuration approach
- Codex 24.04 Plan - Ubuntu 24.04 deployment planning
Launch & Orchestration¶
- Orchestrated Launch - Comprehensive launch system design
- Orchestrated Launch Summary - Quick reference for launch system
Machine Setup¶
- Laptop Setup - Development laptop configuration
- Laptop Diagnostic - Laptop troubleshooting and validation
Synchronization¶
- Deployment Sync - Syncing code across machines
- Laptop Sync After Conversion - Post-migration sync procedures
- Wiki Sync - GitHub Wiki synchronization automation
Deployment Topologies¶
Development Mode¶
- Laptop: Development environment, web UI, mission planning
- Connection: Direct network to robot or simulation
Production Mode¶
- Laptop: Web UI and monitoring
- Thor (Jetson): vLLM backend, mission agent, ROS2 bridge
- GO2 Robot: Hardware platform
- Connection: WiFi mesh network
Key Concepts¶
Environment Variables¶
Critical configuration managed through .env files:
- AGENT_BACKEND - cloud vs local LLM
- GO2_IP - Robot IP address
- ROS_DOMAIN_ID - ROS2 network isolation
- See Environment Variables Guide
Launch Orchestration¶
The start.sh script provides unified deployment:
./start.sh --dev # Development mode
./start.sh --prod # Production mode
Validation¶
- [ ] Environment variables documented and current
- [ ] Launch procedures tested on all target machines
- [ ] Sync procedures validated for code updates
See Also¶
- Networking Hub - Network topology and configuration
- Hardware Hub - Physical device setup
- Software Hub - Software stack and packages
- Troubleshooting Hub - Deployment diagnostics
References¶
- Documentation Root
- Project Overview - Current status and planning