diff --git a/src/pages/agent-network/quickstart.mdx b/src/pages/agent-network/quickstart.mdx index d588fcd8..eb769fa9 100644 --- a/src/pages/agent-network/quickstart.mdx +++ b/src/pages/agent-network/quickstart.mdx @@ -1,21 +1,98 @@ import { Note } from '@/components/mdx' export const description = - 'Get an LLM request routed through NetBird Agent Network end to end: set up the NetBird server with the proxy, connect a provider, create a policy, and make your first keyless call.' + 'Get an LLM request routed through NetBird Agent Network end to end, on NetBird Cloud or self-hosted: set up a private proxy, connect a provider, create a policy, and make your first keyless call.' # NetBird Agent Network Quickstart -This guide takes you from a fresh server to a working, keyless LLM call through -Agent Network. +This guide takes you to a working, keyless LLM call through Agent Network, either on +NetBird Cloud or on a server of your own. - NetBird Agent Network is open source and self-hosted. This guide sets up a minimal deployment with core functionality; - you can enable the full platform later. - - It is currently in beta, and the setup process installs release candidate versions of the platform. + NetBird Agent Network is currently in beta. It is open source, and you can run it on NetBird Cloud or self-host it. -## Infrastructure Requirements +## Choose Where to Run Agent Network + +Agent Network needs two things: a NetBird account, and a **private proxy** that serves your +agent network endpoint. The proxy is reachable only by devices connected to your NetBird +network, so the endpoint never faces the public internet. + +- **NetBird Cloud** is the fastest path. There is no server to install, and NetBird can run a + dedicated private proxy for your account. Follow [Set Up on NetBird Cloud](#set-up-on-net-bird-cloud). +- **Self-hosted** runs the whole platform, proxy included, on a Linux VM you control. Follow + [Set Up Self-Hosted](#set-up-self-hosted). + +With a managed proxy, your LLM requests pass through a proxy that NetBird operates. If those +requests must stay on your own infrastructure, choose **Deploy a new proxy** during the Cloud +setup instead, or self-host. + +## Before You Begin + +Whichever path you choose, you need: + +- **A device for your agent** that can run the NetBird client, such as your laptop. Agent + network endpoints are reachable only over NetBird, so the agent must run on a connected + device. See [Get Started](/get-started) to install the client. +- **Access to an LLM provider**: the API key for a hosted provider such as Anthropic or OpenAI, + or the URL of an AI gateway or a self-hosted model. You enter it once in the dashboard, and it + never goes on the agent's device. See [Providers](/agent-network/providers). +- **An agent or client to test with**, such as Claude Code, Codex, the OpenAI SDK, or cURL. + +## Set Up on NetBird Cloud + +### Cloud Requirements + +- **A NetBird Cloud account**, or an email address to create one. You create it during the + setup below. +- **The owner or admin role**, if you add Agent Network to an existing account. The guided setup + only opens for those roles. +- **Your own server**, only if you choose **Deploy a new proxy** instead of the managed proxy. + See [Clusters](/agent-network/clusters). + +### Activate Agent Network + +1. [Activate Agent Network on NetBird Cloud](https://app.netbird.io/peers?signup_source=netbird.ai): + sign up, or sign in to your existing account. + - A **new account** opens in the focused Agent Network view, which hides the rest of the + dashboard. You can turn it off later in **Settings**; see + [Focused Dashboard View](/agent-network#focused-dashboard-view). + - An **existing account** keeps its dashboard and gains the **Agent Network** menu. +2. Follow the guided setup. It walks you through the same steps this guide describes: + 1. **Connect your device**: install the NetBird client and connect it. See + [Add Your Device to the Network](#add-your-device-to-the-network). + 2. **Set up your proxy**: choose where your agent network endpoint is served from. + - **Managed proxy**: NetBird deploys a dedicated, private proxy for your account and + reserves your endpoint. This usually takes under a minute. + - **Your own proxy**, to keep LLM requests on your own infrastructure: click **Or use your + own proxy instead**, then select a private proxy you already run or **Deploy a new + proxy**. For a new proxy, enter a domain and run the generated + Docker command or cloud deployment on your server; it starts the proxy in private mode. + The setup continues once the proxy connects and your endpoint is reserved. See + [Clusters](/agent-network/clusters). + 3. **Connect a provider**: see [Connect a Provider](#connect-a-provider). + 4. **Create a policy** (existing accounts only): see [Create a Policy](#create-a-policy). + 5. **Configure your agent**: see [Configure Your Agent](#configure-your-agent), then send a + first request. + +On a new account, the setup also prepares the account for Agent Network's deny-by-default +model: it creates a **Users** group with you in it, creates a starter policy that lets +**Users** reach your first provider, and removes the permissive **Default** access control +policy. An existing account keeps its groups and policies, so you create the Agent Network +policy yourself. + +Once your first request goes through, continue at [Verify in Usage & Logs](#verify-in-usage-and-logs). + +## Set Up Self-Hosted + + + This setup installs a minimal deployment with core functionality, using release candidate versions of the + platform. You can enable the full platform later. + + +### Self-Hosted Requirements + +#### Infrastructure - A Linux VM with at least **1 CPU** and **2 GB** of memory. - The VM must be publicly accessible on **TCP ports 80 and 443**, and **UDP port 3478**. @@ -26,7 +103,7 @@ Agent Network. The public domain is not used for the Agent Network itself. It is only used to establish network connectivity and manage the platform. -## Software Requirements +#### Software - Docker with the docker-compose plugin v2 or higher ([Docker installation guide](https://docs.docker.com/engine/install/)) - [jq](https://jqlang.github.io/jq/): install with `sudo apt install jq` or `sudo yum install jq` @@ -40,8 +117,11 @@ Download and run the installation script: curl -fsSL https://pkgs.netbird.io/getting-started.sh | NETBIRD_AGENT_NETWORK=true bash ``` +The script deploys the NetBird server together with a private proxy, so your deployment +already has the proxy Agent Network needs. + Once the script finishes, open `https://netbird.example.com`, create your admin -account on the setup page, create an admin user, and log in. +account on the setup page, create an admin user, and log in. Then continue with the steps below. ## Add Your Device to the Network @@ -59,8 +139,9 @@ and protected by a peer-to-peer encrypted WireGuard tunnel. You should now see your device in the peers list in the NetBird dashboard. -To access a provider via NetBird, you need to use an **agent network endpoint**, which is generated when you connect your -first provider. +To access a provider via NetBird, you need to use an **agent network endpoint**. On a +self-hosted deployment it is generated when you connect your first provider. On NetBird +Cloud it is reserved when you set up your proxy. ## Connect a Provider @@ -83,7 +164,14 @@ See [Providers](/agent-network/providers) for more details. agent network add provider

-You should now see a newly-generated endpoint above the **Providers** table. + + If **Connect Provider** says you need a reverse proxy cluster with private capabilities, your account has no + private proxy yet. The shared NetBird Cloud proxy cluster can't serve an agent network endpoint. Set up a proxy + first, either through the guided setup or under **Agent Network > Configuration > Clusters**. See + [Clusters](/agent-network/clusters). + + +You should now see your agent network endpoint above the **Providers** table.

agent network endpoint @@ -112,6 +200,9 @@ policy explicitly allows it. A policy connects a **Source Group** (your users or agent devices) to one or more **Providers**, and is where you attach optional token and budget limits and guardrails. +If you set up a new NetBird Cloud account through the guided setup, it already created a +starter policy for the **Users** group. Skip to the test request below. + 1. Go to **Team > Users** and add your user to a group, such as **Engineering**. 2. Go to **Agent Network > Policies** and click **Add Policy**. 3. Select the **Source Group** you want to authorize. @@ -141,4 +232,4 @@ recorded with the caller identity, model, tokens, and cost.

agent network usage & logs -

\ No newline at end of file +