🚀 Getting Started with WAIIDE
Calliope Integration: This component is integrated into the Calliope AI platform. Some features and configurations may differ from the upstream project.
Welcome to WAIIDE (Web AI IDE)! This section will help you go from zero to running your first WAIIDE instance in JupyterHub.
📚 Getting Started Path
Follow these guides in order for the smoothest experience:
1. Installation
- Prerequisites and system requirements
- Installing JupyterHub and dependencies
- Docker setup and image pulling
2. Basic Setup
- Minimal JupyterHub configuration
- Testing your first WAIIDE instance
- Verifying the setup works
3. First Instance
- Creating and accessing your first WAIIDE instance
- Understanding the multi-instance architecture
- Basic usage and navigation
⚡ Quick Start Alternative
If you’re experienced with JupyterHub and want to get running immediately, see our 5-minute Quick Start Guide.
🎯 What You’ll Learn
By the end of this getting started section, you’ll understand:
- ✅ How to install and configure WAIIDE with JupyterHub
- ✅ How to create and manage multiple WAIIDE instances
- ✅ How WAIIDE’s clean URL structure works (
/user/username/username-waiide-abc123/) - ✅ How to troubleshoot common setup issues
- ✅ Next steps for production deployment
🏗️ Architecture Overview
WAIIDE provides:
- WAIIDE Server: Full WAIIDE experience in your browser
- JupyterHub Integration: Seamless OAuth authentication and user management
- Multi-Instance Support: Run multiple isolated instances per user
- Clean URLs: Direct access without complex proxy paths
📞 Need Help?
- Stuck? Check our Troubleshooting Guide
- Configuration Questions? See Configuration Docs
- Want to understand more? Read the Architecture Guide
Ready to begin? Start with Installation →