Agent Zero for Cloudron

This is a Cloudron package for Agent Zero, a personal, organic agentic framework that grows and learns with you.

released on CCAI (https://ccai.appx.uk)

released as v1.0.0

Features

• Personal AI Agent: Grows and learns with you.
• Dockerized: Runs securely within Cloudron's isolated environment.
• Persistent Memory: Retains knowledge across restarts.
• Cloudron Integration:
  • Authentication: Uses Cloudron Proxy Auth (Single Sign-On).
  • Storage: Persists data in /app/data.
  • Security: Runs as a non-root user.
• Telegram Ready: Built-in Telegram bot with advanced features:
  • Chat: Talk to Agent Zero directly via Telegram.
  • Learn: Forward messages or files to add to the agent's knowledge base.
  • Run: Execute dynamic automation tasks.
  • Health: Check system status remotely.

Usage

1. Install the app on your Cloudron.
2. Open the app URL.
3. You will be automatically logged in via Cloudron SSO.
4. Configure your API keys (e.g., OpenAI, Anthropic) in the settings or .env file.

Telegram Bot Setup

1. Get a token from @BotFather.
2. Add it to /app/data/config/telegram.json using the File Manager:

   {
     "token": "YOUR_TOKEN",
     "username": "YOUR_BOT_USERNAME"
   }
   

3. Restart the app.

Bot Commands:

• /chat <msg> - Interact with Agent Zero.
• /learn <msg> - Add a note to knowledge. Attach files with caption /learn to save them.
• /run <task> [args] - Run a python script from /app/data/instruments/tasks.
• /health - System diagnostics.

Configuration

API Keys

You can configure API keys in the application settings or by editing the .env file located in /app/data/.env using the Cloudron File Manager.

Custom Tools & Prompts

You can customize the agent by adding files to the respective directories in /app/data:

• prompts/
• instruments/
• knowledge/

Search Engine (Brave Search vs SearXNG)

Agent Zero requires a search engine to function effectively.

Recommendation: Brave Search API We strongly recommend using the Brave Search API instead of SearXNG.

• Reliability: SearXNG instances are often rate-limited or blocked by Google/Bing, causing search failures.
• Speed: Brave Search API is faster and more stable for automated agents.
• Setup:
  1. Get a free API key from Brave Search API.
  2. Edit /app/data/cloudron.env using the File Manager.
  3. Uncomment and set BRAVE_SEARCH_API_KEY=your_api_key_here.
  4. Restart Agent Zero.

Alternative: SearXNG If you prefer self-hosting, you can use SearXNG, but be aware of potential rate-limiting issues.

1. Install SearXNG from the Cloudron App Store.
2. Edit /app/data/cloudron.env using the File Manager.
3. Uncomment and set SEARXNG_URL=https://searx.yourdomain.com.
4. Restart Agent Zero.

Development

Building the Package

# Build the Docker image
cloudron build

# Install on your Cloudron
cloudron install

License

This package is licensed under the MIT License, matching the upstream Agent Zero project.