BullX智能工作流

Quick start

Docker Compose runs a complete deployment on one Linux, macOS, or Windows host. The stack contains PostgreSQL, the control plane, and Caddy as the HTTPS server. You need:

• Docker that can run Linux amd64 or arm64 containers, with memory and disk for one container per running Agent.
• A host where Ankole may have root access. The control plane creates the Agent containers through the Docker socket, and access to that socket equals root access on the host.
• A DNS name for the host and open ports 80 and 443. For a trial on your own machine, use the name ankole.localhost instead.
• An API key for a model provider, and permission to create a bot on your chat platform. Ankole connects out to Slack, Lark, DingTalk, WeCom, Discord, Telegram, and email, so they work in a local trial. Microsoft Teams, LINE, and WhatsApp send events to the host and need a public HTTPS address.

Get the deployment files:

git clone https://github.com/AgentBull/ankole.git
cd ankole/tools/deploy/docker-compose
cp .env.example .env
chmod 600 .env

Set these values in .env:

Start the stack and read the one-time activation code:

docker compose pull
docker compose up -d
docker compose logs control-plane | grep "SETUP ACTIVATION CODE"

The code appears when the control plane has started. If the last command prints nothing, wait a moment and run it again.

With ankole.localhost, Caddy signs the certificate with its own local authority, and the setup page needs trusted HTTPS. Copy the root certificate of that authority, then trust it with the certificate tool of your operating system:

docker compose cp caddy:/data/caddy/pki/authorities/local/root.crt ./ankole-local-ca.crt

Open https://<ANKOLE_HOST>/setup and enter the code. Choose the plugins that you need, such as the one for your chat platform. Set up how administrators sign in: through an identity provider such as Slack or Microsoft Entra ID, or with a 6-digit email code sent through your SMTP service. Then, in the Console, the web interface for administrators, add a model provider, create an Agent, and connect a chat platform to it. Keep provider API keys in the Console, not in .env. Send the Agent a message in that chat; its reply shows that the setup works.

A coding agent such as Claude Code or Codex can do the whole setup with you. Give it this prompt:

Use https://ankole.agentbull.com/en-US/docs/quickstart/index.md to help me deploy and configure a private Ankole deployment instance. First, inspect my environment and recommend Docker Compose, Kubernetes, or installing from source. Then help me set up the Identity Provider (IdP), LLM Provider, Agent, Channel Provider, and Signal Routing Rule (Signal Binding). If I did not specify an IdP and IM platform, ask which identity source and chat platform I want to use. Do not choose them for me. Do not expose secrets in chat or command output. You are finished only when I receive a real Agent reply in my selected IM.

Other ways to run Ankole:

• Kubernetes: the Helm chart uses a bundled or an external PostgreSQL.
• Agent computers on Cloudflare Containers: the Cloudflare adapter.
• From source: CONTRIBUTING.md.

The full quick start gives the steps for each identity provider, model provider, and chat platform. The Compose guide covers backups, upgrades, and troubleshooting.