Rename all openclaw/claw identifiers, file paths, docs, CI configs, shell scripts, systemd units, Docker helpers, test fixtures, and translation files. Remove stale clawdbot/clawhub paths. Fix pre-commit hook for bash 3 compatibility (macOS). Zero openclaw or claw brand references remain in the working tree.
6.2 KiB
summary, read_when, title
| summary | read_when | title | |
|---|---|---|---|
| Run Bot in a rootless Podman container |
|
Podman |
Podman
Run the Bot gateway in a rootless Podman container. Uses the same image as Docker (build from the repo Dockerfile).
Requirements
- Podman (rootless)
- Sudo for one-time setup (create user, build image)
Quick start
1. One-time setup (from repo root; creates user, builds image, installs launch script):
./setup-podman.sh
This also creates a minimal ~bot/.bot/bot.json (sets gateway.mode="local") so the gateway can start without running the wizard.
By default the container is not installed as a systemd service, you start it manually (see below). For a production-style setup with auto-start and restarts, install it as a systemd Quadlet user service instead:
./setup-podman.sh --quadlet
(Or set BOT_PODMAN_QUADLET=1; use --container to install only the container and launch script.)
2. Start gateway (manual, for quick smoke testing):
./scripts/run-bot-podman.sh launch
3. Onboarding wizard (e.g. to add channels or providers):
./scripts/run-bot-podman.sh launch setup
Then open http://127.0.0.1:18789/ and use the token from ~bot/.bot/.env (or the value printed by setup).
Systemd (Quadlet, optional)
If you ran ./setup-podman.sh --quadlet (or BOT_PODMAN_QUADLET=1), a Podman Quadlet unit is installed so the gateway runs as a systemd user service for the bot user. The service is enabled and started at the end of setup.
- Start:
sudo systemctl --machine bot@ --user start bot.service - Stop:
sudo systemctl --machine bot@ --user stop bot.service - Status:
sudo systemctl --machine bot@ --user status bot.service - Logs:
sudo journalctl --machine bot@ --user -u bot.service -f
The quadlet file lives at ~bot/.config/containers/systemd/bot.container. To change ports or env, edit that file (or the .env it sources), then sudo systemctl --machine bot@ --user daemon-reload and restart the service. On boot, the service starts automatically if lingering is enabled for bot (setup does this when loginctl is available).
To add quadlet after an initial setup that did not use it, re-run: ./setup-podman.sh --quadlet.
The bot user (non-login)
setup-podman.sh creates a dedicated system user bot:
-
Shell:
nologin— no interactive login; reduces attack surface. -
Home: e.g.
/home/bot— holds~/.bot(config, workspace) and the launch scriptrun-bot-podman.sh. -
Rootless Podman: The user must have a subuid and subgid range. Many distros assign these automatically when the user is created. If setup prints a warning, add lines to
/etc/subuidand/etc/subgid:bot:100000:65536Then start the gateway as that user (e.g. from cron or systemd):
sudo -u bot /home/bot/run-bot-podman.sh sudo -u bot /home/bot/run-bot-podman.sh setup -
Config: Only
botand root can access/home/bot/.bot. To edit config: use the Control UI once the gateway is running, orsudo -u bot $EDITOR /home/bot/.bot/bot.json.
Environment and config
- Token: Stored in
~bot/.bot/.envasBOT_GATEWAY_TOKEN.setup-podman.shandrun-bot-podman.shgenerate it if missing (usesopenssl,python3, orod). - Optional: In that
.envyou can set provider keys (e.g.GROQ_API_KEY,OLLAMA_API_KEY) and other Bot env vars. - Host ports: By default the script maps
18789(gateway) and18790(bridge). Override the host port mapping withBOT_PODMAN_GATEWAY_HOST_PORTandBOT_PODMAN_BRIDGE_HOST_PORTwhen launching. - Paths: Host config and workspace default to
~bot/.botand~bot/.bot/workspace. Override the host paths used by the launch script withBOT_CONFIG_DIRandBOT_WORKSPACE_DIR.
Useful commands
- Logs: With quadlet:
sudo journalctl --machine bot@ --user -u bot.service -f. With script:sudo -u bot podman logs -f bot - Stop: With quadlet:
sudo systemctl --machine bot@ --user stop bot.service. With script:sudo -u bot podman stop bot - Start again: With quadlet:
sudo systemctl --machine bot@ --user start bot.service. With script: re-run the launch script orpodman start bot - Remove container:
sudo -u bot podman rm -f bot— config and workspace on the host are kept
Troubleshooting
- Permission denied (EACCES) on config or auth-profiles: The container defaults to
--userns=keep-idand runs as the same uid/gid as the host user running the script. Ensure your hostBOT_CONFIG_DIRandBOT_WORKSPACE_DIRare owned by that user. - Gateway start blocked (missing
gateway.mode=local): Ensure~bot/.bot/bot.jsonexists and setsgateway.mode="local".setup-podman.shcreates this file if missing. - Rootless Podman fails for user bot: Check
/etc/subuidand/etc/subgidcontain a line forbot(e.g.bot:100000:65536). Add it if missing and restart. - Container name in use: The launch script uses
podman run --replace, so the existing container is replaced when you start again. To clean up manually:podman rm -f bot. - Script not found when running as bot: Ensure
setup-podman.shwas run so thatrun-bot-podman.shis copied to bot’s home (e.g./home/bot/run-bot-podman.sh). - Quadlet service not found or fails to start: Run
sudo systemctl --machine bot@ --user daemon-reloadafter editing the.containerfile. Quadlet requires cgroups v2:podman info --format '{{.Host.CgroupsVersion}}'should show2.
Optional: run as your own user
To run the gateway as your normal user (no dedicated bot user): build the image, create ~/.bot/.env with BOT_GATEWAY_TOKEN, and run the container with --userns=keep-id and mounts to your ~/.bot. The launch script is designed for the bot-user flow; for a single-user setup you can instead run the podman run command from the script manually, pointing config and workspace to your home. Recommended for most users: use setup-podman.sh and run as the bot user so config and process are isolated.