Getting Started with O1
This guide will help you set up and start using O1 Universal Remote to manage your infrastructure.Prerequisites
Before you begin, ensure you have the following installed:- Node.js 16.x or later
- Docker and Docker Compose
- Ansible 2.9 or later
- Git
- SSH access to target nodes
Installation
1. Clone the Repository
2. Environment Setup
Copy the example environment file and configure your settings:3. Install Dependencies
4. Start the Services
5. Verify Installation
Check that all services are running:First Steps
1. Access the Dashboard
Open your browser tohttp://localhost:3000 to access the O1 dashboard.
2. Add Your First Node
3. Test Node Connection
4. Deploy Your First Application
Configuration
SSH Key Management
O1 uses SSH keys for secure node access. Add your SSH keys:Cloud Provider Setup
Configure cloud provider credentials for automated provisioning:Quick Examples
Launch a Cloud Instance
Monitor Application Health
Troubleshooting
Common Issues
Service Not Starting- Check Docker is running:
docker ps - Verify ports are available:
netstat -tulpn | grep :3000 - Check logs:
docker-compose logs backend
- Verify SSH keys are added correctly
- Check firewall rules on target nodes
- Test SSH manually:
ssh user@host
- Verify CORS settings in
.env - Check API endpoint:
curl http://localhost:3000/health - Review backend logs for errors
Getting Help
- Check the API Reference for detailed endpoint information
- Review common issues in our GitHub issue tracker
- Join our Community Discord for support
- Open an issue on GitHub
