Skip to content

SmythOS Studio: Open-Source Visual AI Agent Builder and deployable runtime stack from SmythOS. Start with an intuitive drag-and-drop workspace, extend with custom code, and deploy your agents anywhere — local, cloud, or edge — with full governance and control.

update readme & compose

ahmedcoder01a73d32292856
diff --git a/DOCKER_COMPOSE.md b/DOCKER_COMPOSE.md
index fcf3e5ba..012f4ab6 100644
--- a/DOCKER_COMPOSE.md
+++ b/DOCKER_COMPOSE.md
@@ -5,34 +5,34 @@ This guide explains how to run SmythOS UI using Docker, both with the standalone
## Contents
- [Docker Setup Guide for SmythOS UI](#docker-setup-guide-for-smythos-ui)
- - [Contents](#contents)
- - [Prerequisites](#prerequisites)
- - [Quick Start with Docker Compose (Recommended)](#quick-start-with-docker compose-recommended)
- - [1. Environment Setup](#1-environment-setup)
- - [2. Start All Services](#2-start-all-services)
- - [3. Access the Application](#3-access-the-application)
- - [Docker Compose Architecture](#docker compose-architecture)
- - [Services Overview](#services-overview)
- - [Network Architecture](#network-architecture)
- - [Volume Management](#volume-management)
- - [Standalone Dockerfile Usage](#standalone-dockerfile-usage)
- - [Running the Container](#running-the-container)
- - [Environment Variables](#environment-variables)
- - [Required Variables](#required-variables)
- - [Production Deployment](#production-deployment)
- - [Domain & SSL/TLS Configuration](#domain-ssltls-configuration)
- - [Security Considerations](#security-considerations)
- - [Troubleshooting](#troubleshooting)
- - [Common Issues](#common-issues)
- - [Maintenance](#maintenance)
- - [Updates](#updates)
+ - [Contents](#contents)
+ - [Prerequisites](#prerequisites)
+ - [Quick Start with Docker Compose (Recommended)](#quick-start-with-docker compose-recommended)
+ - [1. Environment Setup](#1-environment-setup)
+ - [2. Start All Services](#2-start-all-services)
+ - [3. Access the Application](#3-access-the-application)
+ - [Docker Compose Architecture](#docker compose-architecture)
+ - [Services Overview](#services-overview)
+ - [Network Architecture](#network-architecture)
+ - [Volume Management](#volume-management)
+ - [Standalone Dockerfile Usage](#standalone-dockerfile-usage)
+ - [Running the Container](#running-the-container)
+ - [Environment Variables](#environment-variables)
+ - [Required Variables](#required-variables)
+ - [Production Deployment](#production-deployment)
+ - [Domain & SSL/TLS Configuration](#domain-ssltls-configuration)
+ - [Security Considerations](#security-considerations)
+ - [Troubleshooting](#troubleshooting)
+ - [Common Issues](#common-issues)
+ - [Maintenance](#maintenance)
+ - [Updates](#updates)
## Prerequisites
- **Docker**: Version 20.10 or newer
- **Docker Compose**: Version 2.0 or newer (included with Docker Desktop)
- **Root/Admin Access**: Required for Docker commands
-- **System Requirements**:
+- **System Requirements**:
- 8GB RAM minimum
- 10GB free disk space
- Ports 80, 443, 5050, 5053, 8080 available
@@ -60,7 +60,6 @@ cp .env.compose.example .env
(Optional) Edit the `.env` file with your configuration (e.g. changing default passwords, your domains, etc.)
-
### 3. Start All Services
Launch the complete SmythOS UI stack:
@@ -88,12 +87,12 @@ Once all services are healthy:
### Services Overview
-| Service | Purpose | Port | Health Check |
-|---------|---------|------|--------------|
-| **traefik** | Reverse proxy & SSL termination | 80, 443, 8080 | Built-in |
-| **mysql** | Database server | 3306 (internal) | mysqladmin ping |
-| **redis** | Cache & session store | 6379 (internal) | redis-cli ping |
-| **smythos** | Main application | 5050, 5053 | HTTP health endpoints |
+| Service | Purpose | Port | Health Check |
+| ----------- | ------------------------------- | --------------- | --------------------- |
+| **traefik** | Reverse proxy & SSL termination | 80, 443, 8080 | Built-in |
+| **mysql** | Database server | 3306 (internal) | mysqladmin ping |
+| **redis** | Cache & session store | 6379 (internal) | redis-cli ping |
+| **smythos** | Main application | 5050, 5053 | HTTP health endpoints |
### Network Architecture
@@ -139,13 +138,10 @@ docker run -d \
### Required Variables
-| Variable | Description | Example |
-|----------|-------------|---------|
+| Variable | Description | Example |
+| -------------- | ----------------------- | -------------------------------- |
| `DATABASE_URL` | MySQL connection string | `mysql://user:pass@host:3306/db` |
-
-
-
## Production Deployment
### Domain & SSL/TLS Configuration
@@ -153,6 +149,7 @@ docker run -d \
The docker compose setup includes automatic SSL certificate generation via Let's Encrypt:
1. **Configure your domains & tls configuration** in `.env`:
+
```env
APP_DOMAIN=https://yourdomain.com
RUNTIME_DOMAIN=https://runtime.yourdomain.com
@@ -162,9 +159,10 @@ The docker compose setup includes automatic SSL certificate generation via Let's
ENABLE_TLS=true
```
- + remove the `AGENT_DOMAIN_PORT` variable
+ - remove the `AGENT_DOMAIN_PORT` variable
2. **Ensure DNS records** point to your server:
+
```
yourdomain.com A YOUR_SERVER_IP
runtime.yourdomain.com A YOUR_SERVER_IP
@@ -185,13 +183,36 @@ The docker compose setup includes automatic SSL certificate generation via Let's
- **Regular updates** of Docker images
- **Monitor logs** for suspicious activity
-
## Troubleshooting
### Common Issues
+**1. Port conflicts:**
+
+If you see errors like:
+
+```
+docker: Error response from daemon: driver failed programming external connectivity on endpoint <container_name> (xxxxxxxxxxxxxxx): Bind for 0.0.0.0:80 failed: port is already allocated.
+```
+
+or
+
+```
+docker: Error response from daemon: driver failed programming external connectivity on endpoint <container_name> (xxxxxxxxxxxxxxx): Error starting userland proxy: listen tcp 0.0.0.0:0: bind: cannot assign requested address.
+```
+
+This means a service is already running on port 80 and/or 443. You need to stop that service first.
+
+```bash
+# Check what's using the ports
+netstat -tlnp | grep :80
+netstat -tlnp | grep :443
+
+# Stop any service using 80 and/or 443
+```
+
+**2. Services not starting:**
-**1. Services not starting:**
```bash
# Check service status
docker compose ps
@@ -201,7 +222,8 @@ docker compose logs mysql
docker compose logs smythos
```
-**2. Database connection errors:**
+**3. Database connection errors:**
+
```bash
# Verify MySQL is healthy
docker compose exec mysql mysqladmin ping -u root -p
@@ -210,18 +232,6 @@ docker compose exec mysql mysqladmin ping -u root -p
docker compose exec smythos sh -c "mysql -h mysql -u \$DATABASE_USER -p\$DATABASE_PASSWORD -e 'SELECT 1'"
```
-**3. Port conflicts:**
-```bash
-# Check what's using the ports
-netstat -tlnp | grep :80
-netstat -tlnp | grep :443
-
-
-# Either stop any service using 80 and/or 443 OR use different ports in .env (not suitable for production)
-EXPOSE_TRAEFIK_PORT=8080
-EXPOSE_HTTPS_TRAEFIK_PORT=8443
-```
-
## Maintenance
### Updates
@@ -237,7 +247,6 @@ docker compose pull
docker compose up -d
```
-
## Support
For issues with Docker deployment:
diff --git a/README.md b/README.md
index 2165306b..09f3d948 100644
--- a/README.md
+++ b/README.md
@@ -50,8 +50,9 @@ docker compose up -d
🐳 **Full Docker Setup**: See our [Docker Compose Guide](DOCKER_COMPOSE.md) for container deployment with automatic SSL, database, and caching.
----
+**Troubleshooting**: If you encounter any issues during setup, check the [Troubleshooting section](DOCKER_COMPOSE.md#troubleshooting) in the Docker Compose guide.
+---
### Method 2: Local Development Setup
@@ -74,13 +75,13 @@ pnpm dev
```
**Next Steps:**
+
1. Configure your MySQL database in `.env`
2. Set up required subdomains for embodiments
3. Start building your first agent!
📖 **Detailed Setup**: See our [Contributing Guide](CONTRIBUTING.md) for complete development setup instructions.
-
---
## Repository Structure
@@ -92,6 +93,7 @@ This monorepo contains the complete SmythOS UI platform:
The main application containing the visual builder, React frontend, and backend services.
**Key Features:**
+
- **Visual Agent Builder**: Drag-and-drop interface for creating agent workflows
- **React Frontend**: Modern, responsive user interface
- **Backend API**: RESTful services for agent management and execution
@@ -102,6 +104,7 @@ The main application containing the visual builder, React frontend, and backend
Core API services and database management for the SmythOS UI platform.
**Features:**
+
- **Database Management**: Prisma-based ORM with MySQL support
- **API Layer**: Centralized business logic and data access
@@ -110,13 +113,12 @@ Core API services and database management for the SmythOS UI platform.
The execution server that uses (SRE Core Engine)[https://github.com/SmythOS/sre/tree/main] to execute the agents.
**Features:**
+
- **Agent Execution**: High-performance runtime for agent workflows
- **Debugging Tools**: Real-time debugging and monitoring
- **Scalable Architecture**: Handles multiple concurrent agent executions
- **Embodiment Support**: Deploy agents as chatbots, APIs, and integrations
-
-
## Documentation
- **[Contributing Guide](CONTRIBUTING.md)** - Set up your development environment and contribute to the project
@@ -128,6 +130,7 @@ The execution server that uses (SRE Core Engine)[https://github.com/SmythOS/sre/
We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help makes SmythOS UI better for everyone.
**Ways to Contribute:**
+
- 🐛 Report bugs and issues
- 💡 Suggest new features and improvements
- 🔧 Submit pull requests with fixes and enhancements
@@ -135,6 +138,7 @@ We welcome contributions from the community! Whether you're fixing bugs, adding
- 🎨 Design UI/UX improvements
**Get Started:**
+
1. Read our [Contributing Guide](CONTRIBUTING.md)
2. Check out [open issues](https://github.com/SmythOS/smythos-studio/issues)
3. Join our [Discord community](https://discord.gg/smythos)
@@ -156,8 +160,7 @@ We welcome contributions from the community! Whether you're fixing bugs, adding
This project is licensed under the [MIT License](LICENSE).
-
-**Ready to build your first AI agent?**
+**Ready to build your first AI agent?**
🚀 [Get Started Now](#quick-start) | 💬 [Join our Discord](https://discord.gg/smythos) | 🌟 [Star this repo](https://github.com/SmythOS/smythos-studio)
@@ -165,4 +168,4 @@ This project is licensed under the [MIT License](LICENSE).
**/smɪθ oʊ ɛs juː aɪ/**
-*Build visually. Deploy globally. Scale infinitely.*
+_Build visually. Deploy globally. Scale infinitely._