Skip to content

Commit 0c694e8

Browse files
committed
Minor fixes
1 parent 02f9de3 commit 0c694e8

File tree

4 files changed

+56
-129
lines changed

4 files changed

+56
-129
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"label": "Build Agents",
33
"collapsed": true,
4-
"position": 3
4+
"position": 4
55
}

docs/agent-studio/docker-community.mdx

Lines changed: 0 additions & 99 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Self Hosted",
2+
"label": "Self-Hosted Studio",
33
"collapsed": true,
44
"position": 3
55
}
Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
11
---
2-
title: Self-Host SmythOS Studio with Docker
2+
title: Self-Hosted Studio with Docker
33
sidebar_label: Overview
44
description: Learn what you get with a self-hosted SmythOS Studio deployment, system requirements, installation path options, troubleshooting, and FAQs.
55
keywords: [smythos studio, self host, docker compose, open source ai, on prem ai, private deployment, local development, installation guide, troubleshooting, system requirements, networking]
6-
sidebar_position: 1
76
---
87

9-
# Self-Host SmythOS Studio with Docker
8+
# Self-Hosted Studio with Docker
109

1110
<InfoCallout title="What you will learn">
1211
By the end of this guide, you will know what self-hosting gives you, the required setup, available installation paths, and how to troubleshoot common issues.
1312
</InfoCallout>
1413

1514
<Spacer size="md" />
1615

17-
## 1. What’s Included
16+
## What’s Included
1817

19-
Self-hosting gives you the **SmythOS Studio** experience on your own machine or server, including:
18+
Self-hosting gives you the **Studio** experience on your own machine or server, including:
2019

21-
- Visual Studio Canvas for building agents
20+
- Visual Canvas for building agents
2221
- Built-in authentication, Vault, and environment variable management
2322
- Debug, Inspect, and run history
24-
- Local storage by default, with options to connect external services
2523

2624
<TipCallout title="Is this for you?">
27-
This setup is ideal if you can run Docker on a laptop or server and want full control, privacy, and a simple install path.
25+
This setup is ideal if you can run Docker on your machine and want full control, privacy, and a simple install path.
2826
</TipCallout>
2927

3028
<Spacer size="md" />
3129

32-
## 2. System Requirements
30+
## System Requirements
3331

3432
Before starting, make sure your environment meets these minimums:
3533

@@ -43,35 +41,63 @@ Before starting, make sure your environment meets these minimums:
4341

4442
<Spacer size="md" />
4543

46-
## 3. Choose Your Installation Path
44+
## Quickstart
4745

48-
Pick the approach that fits your needs:
4946

50-
### Docker Compose (Recommended)
51-
The simplest and fastest way to get started is the [Quickstart with Docker](/docs/agent-studio/quickstart)
47+
## 1. Clone the Repository
5248

53-
### Local Development Mode
54-
Best if you want to modify Studio or enable hot reload using the [Local Dev Guide](/docs/agent-studio/local-dev)
49+
```bash
50+
git clone https://github.com/SmythOS/smythos-studio.git
51+
cd smythos-studio
52+
```
5553

5654
<Spacer size="md" />
5755

58-
## 4. Installation Flow
56+
## 2. Create Your Environment File
5957

60-
Here’s the general process:
58+
```bash
59+
cp .env.compose.example .env
60+
```
6161

62-
1. Clone the Studio repository
63-
2. Create a `.env` file with your required settings
64-
3. Choose Docker Compose or Local Dev mode
65-
4. Run Studio and open the UI to start building agents
62+
Open `.env` and set at minimum:
6663

64+
```text
65+
DATABASE_URL="mysql://user:pass@db:3306/smythos"
66+
APP_BASE_URL="http://localhost"
67+
SESSION_SECRET="long-random-string"
68+
OPENAI_API_KEY="sk-your-key" # optional
69+
```
70+
71+
<Spacer size="md" />
72+
73+
## 3. Start the Stack
74+
```bash
75+
docker compose up -d
76+
```
77+
78+
Optional: Watch logs to see services start
79+
80+
```bash
81+
docker compose logs -f
82+
```
83+
84+
When services are healthy, open:
85+
86+
```bash
87+
http://localhost
88+
```
89+
You should see the Studio page. Create your first agent and run a quick test.
90+
91+
<Spacer size="md" />
92+
aawa6
6793
<InfoCallout title="Source code">
6894
SmythOS Studio Community Edition is open source.
6995
Browse the code on [GitHub](https://github.com/SmythOS/smythos-studio).
7096
</InfoCallout>
7197

7298
<Spacer size="md" />
7399

74-
## 5. Troubleshooting
100+
## Troubleshooting
75101

76102
**Port already in use**
77103
Stop the conflicting service or change the published ports in Compose.
@@ -91,10 +117,10 @@ Confirm `APP_BASE_URL` matches the actual URL and that proxies forward headers c
91117

92118
<Spacer size="md" />
93119

94-
## 6. FAQ
120+
## FAQ
95121

96122
**Can I run this on a laptop?**
97-
Yes. Start locally and move to a server later without redoing your work.
123+
Yes. It's completly private to your device when you run it locally using Docker.
98124

99125
**Do I need a public domain?**
100126
No. Local setups work without a domain. For shared access, add a reverse proxy and HTTPS.
@@ -107,8 +133,8 @@ Open an issue on [GitHub](https://github.com/SmythOS/smythos-studio) or join the
107133

108134
<Spacer size="md" />
109135

110-
## 7. Next Steps
136+
## Next Steps
111137

112-
- [Go to Quickstart](/docs/agent-studio/quickstart)
113-
- [Learn Core Concepts](/docs/agent-studio/key-concepts/canvas)
114-
- [Build Your First Workflow](/docs/agent-studio/building-workflows)
138+
- Go to [Quickstart](/docs/agent-studio/quickstart)
139+
- Learn the Core Concepts of [Canvas](/docs/agent-studio/key-concepts/canvas)
140+
- Build Your First [Workflow](/docs/agent-studio/build-agents/building-workflows)

0 commit comments

Comments
 (0)