Skip to content

Commit 797def4

Browse files
authored
Merge pull request #1398 from 3clyp50/docsupdate
2 parents 0bbc657 + 97591b6 commit 797def4

4 files changed

Lines changed: 73 additions & 52 deletions

File tree

docs/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Welcome to the Agent Zero documentation hub. Whether you're getting started or d
66
## Quick Start
77

88
- **[Quickstart Guide](quickstart.md):** Get up and running in 5 minutes with Agent Zero.
9-
- **[Installation Guide](setup/installation.md):** Detailed setup instructions for all platforms (or [update your installation](setup/installation.md#how-to-update-agent-zero)).
9+
- **[Installation Guide](setup/installation.md):** Install scripts, updates, and advanced Docker setup (includes [How to Update](setup/installation.md#how-to-update-agent-zero)).
10+
- **[Self Update](guides/self-update.md):** How the in-app updater works (technical reference).
1011
- **[VPS Deployment](setup/vps-deployment.md):** Deploy Agent Zero on a remote server.
1112
- **[Development Setup](setup/dev-setup.md):** Set up a local development environment.
1213

@@ -45,6 +46,8 @@ Welcome to the Agent Zero documentation hub. Whether you're getting started or d
4546
- [Quick Start](#quick-start)
4647
- [Quickstart Guide](quickstart.md)
4748
- [Installation Guide](setup/installation.md)
49+
- [How to Update Agent Zero](setup/installation.md#how-to-update-agent-zero)
50+
- [Manual Installation (Advanced)](setup/installation.md#manual-installation-advanced)
4851
- [Step 1: Install Docker Desktop](setup/installation.md#step-1-install-docker-desktop)
4952
- [Windows Installation](setup/installation.md#-windows-installation)
5053
- [macOS Installation](setup/installation.md#-macos-installation)
@@ -63,7 +66,7 @@ Welcome to the Agent Zero documentation hub. Whether you're getting started or d
6366
- [Choosing Your LLMs](setup/installation.md#choosing-your-llms)
6467
- [Installing Ollama (Local Models)](setup/installation.md#installing-and-using-ollama-local-models)
6568
- [Using on Mobile Devices](setup/installation.md#using-agent-zero-on-your-mobile-device)
66-
- [How to Update Agent Zero](setup/installation.md#how-to-update-agent-zero)
69+
- [Self Update (technical)](guides/self-update.md)
6770
- [VPS Deployment](setup/vps-deployment.md)
6871
- [Development Setup](setup/dev-setup.md)
6972

docs/guides/self-update.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Self Update
22

3+
## Using Self Update in the Web UI
4+
5+
For day-to-day upgrades inside a running instance:
6+
7+
1. **Settings → Update** → open **Self Update**
8+
2. Select the target version
9+
3. Click **Restart and Update**
10+
11+
The UI will tell you when a new A0 update is available for download.
12+
13+
---
14+
15+
## Technical reference
16+
317
Agent Zero includes a Docker-oriented self-update flow for switching to a specific repository version tag on `main`, `testing`, or `development`.
418

519
## How it works

docs/quickstart.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,44 @@
11
# Quick Start
2-
This guide provides a quick introduction to using Agent Zero. We'll cover the essential installation steps and running your first Skill.
2+
This guide provides a quick introduction to using Agent Zero. We'll cover the recommended install path and running your first Skill.
33

4-
## Installation Steps
4+
## Installation (recommended)
55

6-
### Step 1: Install Docker Desktop
7-
8-
Download and install Docker Desktop for your operating system:
9-
10-
- **Windows:** Download from [Docker Desktop](https://www.docker.com/products/docker-desktop/) and run the installer with default settings
11-
- **macOS:** Download for Apple Silicon or Intel, drag to Applications, and enable the Docker socket in Settings → Advanced
12-
- **Linux:** Install Docker Desktop or docker-ce following the [official instructions](https://docs.docker.com/desktop/install/linux-install/)
13-
14-
> [!TIP]
15-
> For complete OS-specific installation instructions, see the [full Installation Guide](setup/installation.md#step-1-install-docker-desktop).
16-
17-
### Step 2: Pull the Agent Zero Image
18-
19-
Using Docker Desktop GUI, search for `agent0ai/agent-zero` and click Pull, or use the terminal:
6+
Run one command; the script handles Docker, image pull, and container setup.
207

8+
**macOS / Linux:**
219
```bash
22-
docker pull agent0ai/agent-zero
10+
curl -fsSL https://bash.agent-zero.ai | bash
2311
```
2412

25-
### Step 3: Run the Container
26-
27-
**Using Docker Desktop:** Go to Images tab, click Run next to `agent0ai/agent-zero`, open Optional settings, map a host port to container port `80` (use `0` for automatic assignment), then click Run.
13+
**Windows (PowerShell):**
14+
```powershell
15+
irm https://ps.agent-zero.ai | iex
16+
```
2817

29-
**Using Terminal:**
18+
Follow the CLI prompts for port and authentication, complete onboarding, then open the Web UI URL from the terminal.
3019

31-
```bash
32-
docker run -p 0:80 agent0ai/agent-zero
33-
```
20+
> [!TIP]
21+
> To update later, use **Settings → Update → Self Update** (see [How to Update](setup/installation.md#how-to-update-agent-zero)). Always create a backup under **Settings → Backup & Restore** first.
3422
35-
The container will start in a few seconds. Find the mapped port in Docker Desktop (shown as `<PORT>:80`).
23+
> [!NOTE]
24+
> For manual Docker Desktop setup, volume mapping, and platform-specific detail, see the [Installation Guide](setup/installation.md#manual-installation-advanced).
3625
37-
### Step 4: Open the Web UI and Configure API Key
26+
### Open the Web UI and configure your API key
3827

39-
Open your browser and navigate to `http://localhost:<PORT>`. The Web UI will show a warning banner about missing API key.
28+
Open your browser and navigate to `http://localhost:<PORT>`. The Web UI will show the onboarding banner. Click Start Onboarding to set your AI models and API key.
4029

4130
![Agent Zero Web UI](res/setup/6-docker-a0-running-new.png)
4231

4332
Click **Add your API key** to open Settings and configure:
4433

4534
- **Default Provider:** OpenRouter (supports most models with a single API key)
4635
- **Alternative Providers:** Anthropic, OpenAI, Ollama/LM Studio (local models), and many others
47-
- **Model Selection:** Choose your chat model (e.g., `anthropic/claude-sonnet-4-5` for OpenRouter)
36+
- **Model Selection:** Choose your chat model (e.g., `anthropic/claude-sonnet-4-6` for OpenRouter)
4837

4938
> [!NOTE]
5039
> Agent Zero supports any LLM provider, including local models via Ollama. For detailed provider configuration and local model setup, see the [Installation Guide](setup/installation.md#choosing-your-llms).
5140
52-
### Step 5: Start Your First Chat
41+
### Start your first chat
5342

5443
Once configured, you'll see the Agent Zero dashboard with access to:
5544

docs/setup/installation.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,46 @@ irm https://ps.agent-zero.ai | iex
2323
docker run -p 80:80 agent0ai/agent-zero
2424
```
2525

26-
Once the install completes, open the URL shown in your terminal to access the Web UI and proceed to [Step 3: Configure Agent Zero](#step-3-configure-agent-zero).
26+
Once the install completes, open the URL shown in your terminal to access the Web UI. Follow the prompts in the CLI to set your port and authentication, complete onboarding, add your API key, then continue to [Step 3: Configure Agent Zero](#step-3-configure-agent-zero).
2727

2828
---
2929

30-
## Manual Docker Setup
30+
## How to Update Agent Zero
31+
32+
### Self Update (Recommended)
33+
34+
Use the built-in updater in the Web UI (since v1.5):
35+
36+
1. Go to **Settings → Update** and open **Self Update**
37+
2. Choose the version you want
38+
3. Click **Restart and Update**
39+
40+
For technical details of the updater, see [Self Update](../guides/self-update.md).
41+
42+
### Manual Update (Advanced)
43+
44+
> Use this only if Self Update is unavailable or you must manage containers yourself (for example, some custom Docker setups).
45+
46+
1. Keep the current container running
47+
2. `docker pull agent0ai/agent-zero:latest`
48+
3. Start a **new** container on a different host port, for example: `docker run -d -p 50081:80 --name agent-zero-new agent0ai/agent-zero`
49+
4. On the **old** instance: **Settings → Backup & Restore → Create Backup**
50+
5. On the **new** instance: **Restore** the backup
51+
6. Verify chats and data, then remove the old container
52+
53+
> [!CAUTION]
54+
> Do not delete the old container until the new one has your data.
55+
56+
> [!TIP]
57+
> If the new instance fails to load settings, remove `/a0/usr/settings.json` and restart to regenerate default settings.
58+
59+
---
60+
61+
## Manual Installation (Advanced)
3162

32-
If you prefer to set things up manually, follow the steps below.
63+
> Users should use [Quick Start (Recommended)](#quick-start-recommended) above. The steps below are for custom Docker setups, air-gapped installs, or when you cannot use the install scripts.
64+
65+
Follow the steps below to install Docker and run the image by hand.
3366

3467
### Step 1: Install Docker Desktop
3568

@@ -494,24 +527,6 @@ ollama rm <model-name>
494527
495528
---
496529

497-
## How to Update Agent Zero
498-
499-
> [!NOTE]
500-
> Since v0.9, Agent Zero includes a Backup & Restore workflow in the Settings UI. This is the **safest** way to upgrade Docker instances.
501-
502-
### Recommended Update Process (Docker)
503-
504-
1. **Keep the old container running** and note its port.
505-
2. **Pull the new image** (`agent0ai/agent-zero:latest`).
506-
3. **Start a new container** on a different host port.
507-
4. In the **old** instance, open **Settings → Backup & Restore** and create a backup.
508-
5. In the **new** instance, restore that backup from the same panel.
509-
510-
> [!TIP]
511-
> If the new instance fails to load settings, remove `/a0/usr/settings.json` and restart to regenerate default settings.
512-
513-
---
514-
515530
## Using Agent Zero on Your Mobile Device
516531

517532
Agent Zero can be accessed from mobile devices and other computers using the built-in **Tunnel feature**.

0 commit comments

Comments
 (0)