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.

add default agent domain host related warning to readme md file

Forhad Hosainaac108c9e7c2
diff --git a/packages/runtime/.env.example b/packages/runtime/.env.example
index 87544012..effc9fa0 100644
--- a/packages/runtime/.env.example
+++ b/packages/runtime/.env.example
@@ -14,10 +14,9 @@ UI_SERVER="http://localhost:4000"
SESSION_SECRET="session-secret"
DATA_PATH="path/to/store/data"
-# DEFAULT_AGENT_DOMAIN serves as the staging/development wildcard domain (e.g., agentid.staging.smythos.dev) where non-deployed agents are automatically accessible for testing and development purposes.
+# DEFAULT_AGENT_DOMAIN serves as the staging/development wildcard domain (e.g., agentid.staging.smythos.dev) where non-deployed agents are automatically accessible for testing and development purposes. To run the agent locally, the domain name must contain `localagent`
DEFAULT_AGENT_DOMAIN="localagent.stage.smyth.ai"
+AGENT_DOMAIN_PORT="5053"
# PROD_AGENT_DOMAIN is the production wildcard domain (e.g., agentid.smythos.ai) where deployed agents are served to end users, with the system automatically routing agents to this domain once they are marked as deployed.
PROD_AGENT_DOMAIN="agentid.smythos.com"
-AGENT_DOMAIN_PORT="5053"
-BUILD="dev"
diff --git a/packages/runtime/README.md b/packages/runtime/README.md
index 6e2565e7..38722dab 100644
--- a/packages/runtime/README.md
+++ b/packages/runtime/README.md
@@ -138,6 +138,11 @@ DATA_PATH="/path/to/your/data"
```
### Domain Configuration:
+
+> **⚠️ WARNING**: To run the agent locally, the domain name must contain `localagent`
+
+When running agents in a local development environment, ensure your domain configuration includes the keyword `localagent`. This is required for proper local agent execution and routing.
+
```bash
# Development/staging wildcard domain
DEFAULT_AGENT_DOMAIN="localagent.stage.yourdomain.ai"
@@ -146,6 +151,15 @@ DEFAULT_AGENT_DOMAIN="localagent.stage.yourdomain.ai"
PROD_AGENT_DOMAIN="agentid.yourdomain.com"
```
+**Example:**
+```bash
+# ✅ Correct - domain contains 'localagent'
+DEFAULT_AGENT_DOMAIN="localagent.stage.yourdomain.ai"
+
+# ❌ Incorrect - missing 'localagent' keyword
+DEFAULT_AGENT_DOMAIN="localhost:3000"
+```
+
## 🌐 Deployment
### Environment Requirements