Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
cada5b2
docs: expand homepage features and use cases
ashpreetbedi Jul 19, 2026
c52184c
docs: restore the homepage flow
ashpreetbedi Jul 19, 2026
482972f
docs: use a table for homepage use cases
ashpreetbedi Jul 19, 2026
9c4bec8
docs: tighten homepage section spacing
ashpreetbedi Jul 19, 2026
2eebc2a
docs: refine homepage use cases table
ashpreetbedi Jul 19, 2026
7ca8109
docs: simplify homepage getting started links
ashpreetbedi Jul 19, 2026
3b9fb36
docs: prioritize flagship use cases
ashpreetbedi Jul 19, 2026
ff5e2ae
docs: refine flagship use cases and navigation
ashpreetbedi Jul 19, 2026
1a785f1
docs: deepen data labeling guides
ashpreetbedi Jul 19, 2026
0a1dc32
docs: tighten data and research use cases
ashpreetbedi Jul 19, 2026
312cce8
docs: tighten document processing guides
ashpreetbedi Jul 19, 2026
276c69f
docs: remove unused knowledge redirect
ashpreetbedi Jul 19, 2026
54f9f27
docs: strengthen control plane overview
ashpreetbedi Jul 19, 2026
fdf777f
docs: clarify use case positioning
ashpreetbedi Jul 19, 2026
954b6a1
docs: strengthen feature positioning
ashpreetbedi Jul 19, 2026
5fc580e
docs: improve agent platform journey
ashpreetbedi Jul 19, 2026
d3fe71f
docs: improve AgentOS onboarding
ashpreetbedi Jul 19, 2026
5d1d199
Improve AgentOS template documentation
ashpreetbedi Jul 19, 2026
495ae08
docs: refine agent platform and starter guidance
ashpreetbedi Jul 19, 2026
723a2e9
docs: restore AgentOS security overview
ashpreetbedi Jul 20, 2026
c17a632
docs: refine AgentOS introduction copy
ashpreetbedi Jul 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 65 additions & 19 deletions agent-os/connect-your-os.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,63 @@ title: "Connect Your AgentOS"
description: "Connect your AgentOS to the control plane for monitoring and management."
---

## Connect Your AgentOS
Connect a local or deployed AgentOS runtime to monitor and manage its agents, teams, and workflows from the [AgentOS Control Plane](https://os.agno.com).

1. Open [os.agno.com](https://os.agno.com) and sign in
2. Click **"Add new OS"**
## Before You Connect

| Runtime | Requirements |
|---------|--------------|
| Local | AgentOS running on your machine and reachable from your browser, usually at `http://localhost:7777` or `http://localhost:8000` |
| Live | AgentOS available at a browser-reachable HTTPS URL with [Security & Auth](/agent-os/security/overview) configured for production traffic |

<Note>
Live AgentOS connections require a paid plan.
</Note>

## Connect the Runtime

<Steps>
<Step title="Open the Control Plane">
Open [os.agno.com](https://os.agno.com), sign in, and click **CONNECT OS**.
</Step>

<Step title="Enter the connection details">
Choose **Local** or **Live**, then complete the form:

| Field | Value |
|-------|-------|
| **Environment** | **Local** for a runtime on your machine. **Live** for a browser-reachable HTTPS endpoint. |
| **Endpoint URL** | The AgentOS base URL, such as `http://localhost:7777`. Do not include `/docs` or another route. |
| **Name** | The label shown in the runtime selector, such as `Development`. |
| **Tags** | Optional labels such as `dev`, `stg`, or `prd`. |
</Step>

<Step title="Connect the runtime">
Click **CONNECT**. For Control Plane-managed JWT authorization, enable **Token-Based Authorization (JWT)** before connecting. The Control Plane creates a signing key pair and shows the public verification key.
</Step>

<Step title="Configure Control Plane-managed JWT authorization">
If you enabled **Token-Based Authorization (JWT)**, copy the generated public key into `JWT_VERIFICATION_KEY`, run AgentOS with `authorization=True`, then restart or redeploy the runtime.

```bash
export JWT_VERIFICATION_KEY="your-public-key"
```

The Control Plane keeps the matching private signing key and uses it to issue scoped tokens. See the [Authorization quickstart](/agent-os/security/authorization/quickstart) for the complete runtime configuration.

Keep your existing credential setup when the runtime already uses `OS_SECURITY_KEY` or self-managed JWTs. See [Security & Auth](/agent-os/security/overview) for the available authentication paths.
</Step>

<Step title="Verify the connection">
Select the runtime again after it restarts.

| Check | Expected |
|-------|----------|
| Connection | A green indicator appears beside the runtime name. |
| Components | Registered agents, teams, and workflows appear on Home. |
| Test run | Select a component in Chat and start a new session. |
</Step>
</Steps>

<Frame>
<video
Expand All @@ -21,21 +74,14 @@ description: "Connect your AgentOS to the control plane for monitoring and manag
</video>
</Frame>

## Configure Connection

| Field | Description |
|-------|-------------|
| **Environment** | Local (`http://localhost:7777`) or Live (your HTTPS URL) |
| **Endpoint URL** | Where your AgentOS is running |
| **OS Name** | A descriptive name, e.g. "Development OS" |
| **Tags** | Optional. Organize with labels like `dev`, `stg`, `prd` |

Click **"CONNECT"**. If successful, your OS appears in the dashboard.
<Tip>
If your browser blocks a local connection, allow local-network access for `os.agno.com`. See [AgentOS Connection Issues](/faq/agentos-connection) for browser-specific steps.
</Tip>

## Verify Connection
## Next Steps

| Indicator | Expected |
|-----------|----------|
| Status | "Running" |
| Features | Chat, Knowledge, Memory, Sessions accessible |
| Agents | Configured agents appear in the chat interface |
| Task | Guide |
|------|-------|
| Run a component and inspect its session | [AgentOS Control Plane](/agent-os/control-plane) |
| Configure authentication and permissions | [Security & Auth](/agent-os/security/overview) |
| Call the runtime from an application | [Using the AgentOS API](/agent-os/using-the-api) |
Loading
Loading