Quick Start Guide
Relevant source files
The following files were used as context for generating this wiki page:
Introduction
The Aether-X Ultimate platform is an unrestricted AI ecosystem designed to integrate advanced content generation, no-code development tools, and robust microservice security. This guide provides the necessary steps to initialize the development environment, configure infrastructure, and deploy the service mesh.
The system is built on a microservices architecture, utilizing Docker for containerization and Kubernetes for production orchestration. It supports multiple database engines including MySQL, PostgreSQL, MongoDB, and Cassandra to handle diverse data types from user management to high-availability content storage.
Sources: README.md:3-23, IMPLEMENTATION_COMPLETE.md:7-19
Environment Setup
Before running the application, the local environment must be prepared using the provided setup script. This script configures the directory structure and generates the base development configuration.
Prerequisites
- Docker and Docker Compose
- Python 3.9+
- Node.js 16+ (for dashboard components)
- Kubernetes (optional, for production deployment)
Sources: README.md:30-33, setup-dev.sh:150-154
Initialization Steps
-
Repository Configuration: Clone the repository and execute the setup script.
./setup-dev.shThis script creates
logs/,temp/, anddocs/directories, and generates aconfig/development.yamlfile containing port assignments and database credentials.
Sources: setup-dev.sh:6-147, IMPLEMENTATION_COMPLETE.md:23-25 -
Database Initialization: The platform requires several databases to be initialized with specific schemas.
cd infrastructure/databases ./init-databases.sh docker-compose up -dThis script prepares SQL and NoSQL environments, including creating the
aether_x_dbin MySQL and PostgreSQL, and defining collections in MongoDB and Cassandra.
Sources: infrastructure/databases/init-databases.sh:5-188, README.md:38-42
Architecture Overview
The following diagram illustrates the high-level flow of an incoming request through the API Gateway to various specialized microservices.
The API Gateway acts as the central entry point, handling rate limiting and routing requests to internal services based on the endpoint path.
Sources: docker-compose.yml:1-160, services/api-gateway/app.py:16-160
Service Management
Aether-X services are managed via Docker Compose for local development or shell scripts for automated deployment.
Development Commands
| Action | Command | Description |
|---|---|---|
| Start All | docker-compose up -d | Starts microservices and infrastructure in background |
| Rebuild | docker-compose up --build -d | Rebuilds images and restarts services |
| Stop | docker-compose down | Stops and removes containers |
| View Logs | docker-compose logs -f | Follows output logs for all services |
| Sources: setup-dev.sh:190-195, IMPLEMENTATION_COMPLETE.md:23-28 |
Verification and Testing
After deployment, verify the health of the system using the unified test suite:
./test.sh
The test suite performs health checks on all ports (8000-8006), validates text/image generation endpoints, and tests security features like user registration and login.
Sources: test.sh:13-305
Infrastructure Components
The system relies on a complex infrastructure stack defined in the core configuration.
| Component | Port | Purpose |
|---|---|---|
| API Gateway | 80 | Load balancing and request routing |
| MySQL | 3306 | User management and relational app data |
| PostgreSQL | 5432 | Workflow definitions and structured data |
| Redis | 6379 | Session storage and caching |
| Prometheus | 9090 | Metrics collection |
| Grafana | 3001 | Monitoring dashboards |
| Sources: README.md:14-23, docker-compose.yml:165-200, setup-dev.sh:95-125 |
Production Deployment
For production environments, the platform is deployed to a Kubernetes cluster using the deploy.sh script.
The deployment script automates the creation of the aether-x namespace, sets up persistent volume claims for AI models, and configures Nginx Ingress for external access.
Sources: deploy.sh:14-118, k8s/deployment.yaml:1-290
Conclusion
Setting up Aether-X Ultimate involves a three-stage process: configuring the local development environment via setup-dev.sh, initializing the multi-engine database stack with init-databases.sh, and finally launching the microservices through Docker Compose. Once operational, the platform provides a unified API for AI-driven operations and secure application development.
Sources: IMPLEMENTATION_COMPLETE.md:100-115