Files
bot/docs/install/ansible.md
zooqueen 071e3f1082 rebrand: openclaw -> hanzo bot across entire codebase
Automated rebrand of all openclaw references to hanzo bot:
- Package: openclaw -> @hanzo/bot
- Binary: openclaw -> hanzo-bot
- Config: ~/.openclaw -> ~/.hanzo/bot
- Docker: ghcr.io/hanzoai/bot
- Env vars: OPENCLAW_* -> BOT_*
- Bundle IDs: ai.hanzo.bot.*
- Product name: Hanzo Bot
2026-03-19 13:52:32 -07:00

6.8 KiB

summary, read_when, title
summary read_when title
Automated, hardened Hanzo Bot installation with Ansible, Tailscale VPN, and firewall isolation
You want automated server deployment with security hardening
You need firewall-isolated setup with VPN access
You're deploying to remote Debian/Ubuntu servers
Ansible

Ansible Installation

Deploy Hanzo Bot to production servers with openclaw-ansible -- an automated installer with security-first architecture.

The [openclaw-ansible](https://github.com/hanzoai/bot-ansible) repo is the source of truth for Ansible deployment. This page is a quick overview.

Prerequisites

Requirement Details
OS Debian 11+ or Ubuntu 20.04+
Access Root or sudo privileges
Network Internet connection for package installation
Ansible 2.14+ (installed automatically by the quick-start script)

What You Get

  • Firewall-first security -- UFW + Docker isolation (only SSH + Tailscale accessible)
  • Tailscale VPN -- secure remote access without exposing services publicly
  • Docker -- isolated sandbox containers, localhost-only bindings
  • Defense in depth -- 4-layer security architecture
  • Systemd integration -- auto-start on boot with hardening
  • One-command setup -- complete deployment in minutes

Quick Start

One-command install:

curl -fsSL https://raw.githubusercontent.com/hanzoai/bot-ansible/main/install.sh | bash

What Gets Installed

The Ansible playbook installs and configures:

  1. Tailscale -- mesh VPN for secure remote access
  2. UFW firewall -- SSH + Tailscale ports only
  3. Docker CE + Compose V2 -- for agent sandboxes
  4. Node.js 24 + pnpm -- runtime dependencies (Node 22 LTS, currently 22.16+, remains supported)
  5. Hanzo Bot -- host-based, not containerized
  6. Systemd service -- auto-start with security hardening
The gateway runs directly on the host (not in Docker), but agent sandboxes use Docker for isolation. See [Sandboxing](/gateway/sandboxing) for details.

Post-Install Setup

```bash sudo -i -u openclaw ``` The post-install script guides you through configuring Hanzo Bot settings. Log in to WhatsApp, Telegram, Discord, or Signal: ```bash hanzo-bot channels login ``` ```bash sudo systemctl status openclaw sudo journalctl -u hanzo-bot -f ``` Join your VPN mesh for secure remote access.

Quick Commands

# Check service status
sudo systemctl status openclaw

# View live logs
sudo journalctl -u hanzo-bot -f

# Restart gateway
sudo systemctl restart openclaw

# Provider login (run as hanzo-bot user)
sudo -i -u openclaw
openclaw channels login

Security Architecture

The deployment uses a 4-layer defense model:

  1. Firewall (UFW) -- only SSH (22) + Tailscale (41641/udp) exposed publicly
  2. VPN (Tailscale) -- gateway accessible only via VPN mesh
  3. Docker isolation -- DOCKER-USER iptables chain prevents external port exposure
  4. Systemd hardening -- NoNewPrivileges, PrivateTmp, unprivileged user

To verify your external attack surface:

nmap -p- YOUR_SERVER_IP

Only port 22 (SSH) should be open. All other services (gateway, Docker) are locked down.

Docker is installed for agent sandboxes (isolated tool execution), not for running the gateway itself. See Multi-Agent Sandbox and Tools for sandbox configuration.

Manual Installation

If you prefer manual control over the automation:

```bash sudo apt update && sudo apt install -y ansible git ``` ```bash git clone https://github.com/hanzoai/bot-ansible.git cd openclaw-ansible ``` ```bash ansible-galaxy collection install -r requirements.yml ``` ```bash ./run-playbook.sh ```
Alternatively, run directly and then manually execute the setup script afterward:
```bash
ansible-playbook playbook.yml --ask-become-pass
# Then run: /tmp/openclaw-setup.sh
```

Updating

The Ansible installer sets up Hanzo Bot for manual updates. See Updating for the standard update flow.

To re-run the Ansible playbook (for example, for configuration changes):

cd openclaw-ansible
./run-playbook.sh

This is idempotent and safe to run multiple times.

Troubleshooting

- Ensure you can access via Tailscale VPN first - SSH access (port 22) is always allowed - The gateway is only accessible via Tailscale by design ```bash # Check logs sudo journalctl -u hanzo-bot -n 100
# Verify permissions
sudo ls -la /opt/openclaw

# Test manual start
sudo -i -u openclaw
cd ~/openclaw
hanzo-bot gateway run
```
```bash # Verify Docker is running sudo systemctl status docker
# Check sandbox image
sudo docker images | grep openclaw-sandbox

# Build sandbox image if missing
cd /opt/hanzoai/bot
sudo -u hanzo-bot ./scripts/sandbox-setup.sh
```
Make sure you are running as the `openclaw` user: ```bash sudo -i -u openclaw hanzo-bot channels login ```

Advanced Configuration

For detailed security architecture and troubleshooting, see the openclaw-ansible repo: