mirror of
https://github.com/Kilo-Org/kilocode.git
synced 2026-09-01 15:32:11 +08:00
Merge pull request #7602 from Kilo-Org/docs/kiloclaw-1password-integration
[docs] Add tools and edit format for KiloClaw docs
This commit is contained in:
Ligia Zanchet
@@ -7,19 +7,62 @@ export const KiloClawNav: NavSection[] = [
|
||||
{ href: "/kiloclaw/overview", children: "Overview" },
|
||||
{ href: "/kiloclaw/dashboard", children: "Dashboard" },
|
||||
{ href: "/kiloclaw/pre-installed-software", children: "Pre-installed Software" },
|
||||
{ href: "/kiloclaw/control-ui", children: "Control UI" },
|
||||
{ href: "/kiloclaw/chat-platforms", children: "Chat Platforms" },
|
||||
{
|
||||
href: "/kiloclaw/development-tools/github",
|
||||
href: "/kiloclaw/control-ui/overview",
|
||||
children: "Control UI",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/control-ui/overview", children: "Overview" },
|
||||
{ href: "/kiloclaw/control-ui/changing-models", children: "Changing Models" },
|
||||
{ href: "/kiloclaw/control-ui/exec-approvals", children: "Exec Approvals" },
|
||||
{ href: "/kiloclaw/control-ui/version-pinning", children: "Version Pinning" },
|
||||
],
|
||||
},
|
||||
{
|
||||
href: "/kiloclaw/chat-platforms",
|
||||
children: "Chat Platforms",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/chat-platforms", children: "Overview" },
|
||||
{ href: "/kiloclaw/chat-platforms/telegram", children: "Telegram" },
|
||||
{ href: "/kiloclaw/chat-platforms/discord", children: "Discord" },
|
||||
{ href: "/kiloclaw/chat-platforms/slack", children: "Slack" },
|
||||
],
|
||||
},
|
||||
{
|
||||
href: "/kiloclaw/development-tools",
|
||||
children: "Development Tools",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/development-tools", children: "Overview" },
|
||||
{ href: "/kiloclaw/development-tools/github", children: "GitHub" },
|
||||
{ href: "/kiloclaw/development-tools/google", children: "Google Workspace" },
|
||||
],
|
||||
},
|
||||
{ href: "/kiloclaw/version-pinning", children: "Version Pinning" },
|
||||
{ href: "/kiloclaw/troubleshooting", children: "Troubleshooting" },
|
||||
{ href: "/kiloclaw/pricing", children: "Pricing" },
|
||||
{
|
||||
href: "/kiloclaw/tools",
|
||||
children: "Tools",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/tools", children: "Overview" },
|
||||
{ href: "/kiloclaw/tools/1password", children: "1Password" },
|
||||
{ href: "/kiloclaw/tools/brave-search", children: "Brave Search" },
|
||||
{ href: "/kiloclaw/tools/agentcard", children: "AgentCard" },
|
||||
],
|
||||
},
|
||||
{
|
||||
href: "/kiloclaw/troubleshooting/common-questions",
|
||||
children: "Troubleshooting",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/troubleshooting/common-questions", children: "Common Questions" },
|
||||
{ href: "/kiloclaw/troubleshooting/gateway-process", children: "Gateway Process States" },
|
||||
{ href: "/kiloclaw/troubleshooting/architecture", children: "Architecture Notes" },
|
||||
],
|
||||
},
|
||||
{
|
||||
href: "/kiloclaw/faq/general",
|
||||
children: "FAQ",
|
||||
subLinks: [
|
||||
{ href: "/kiloclaw/faq/general", children: "General" },
|
||||
{ href: "/kiloclaw/faq/pricing", children: "Pricing" },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
]
|
||||
|
||||
@@ -1,155 +0,0 @@
|
||||
---
|
||||
title: "Connecting Chat Platforms"
|
||||
description: "Connect your KiloClaw agent to Telegram, Discord, Slack, and more"
|
||||
---
|
||||
|
||||
# Connecting Chat Platforms
|
||||
|
||||
KiloClaw supports connecting your AI agent to Telegram, Discord, and Slack. You can configure channels from the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard#channels), or from the OpenClaw Control UI after accessing your instance.
|
||||
|
||||
While the exact steps vary for configuring a chat platform (called a _channel_ by OpenClaw), the steps are to:
|
||||
|
||||
1. Configure the channel
|
||||
2. Redeploy the KiloClaw instance
|
||||
3. Initiate the pairing in the chat app
|
||||
4. Accept the pairing request in the [KiloClaw UI](https://app.kilo.ai/claw)
|
||||
|
||||
Detailed instructions for supported chat apps are below.
|
||||
|
||||
## Chat Apps (Channels)
|
||||
|
||||
### Telegram
|
||||
|
||||
1. Open Telegram and search for [@BotFather](https://t.me/BotFather)
|
||||
2. Send `/newbot` and follow the prompts to create your bot
|
||||
3. Copy the **Bot Token** that BotFather gives you
|
||||
4. Go to the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard)
|
||||
5. Paste the token into the **Telegram Bot Token** field
|
||||
6. Click **Save**
|
||||
7. Redeploy your KiloClaw instance
|
||||
8. Send a direct message to your bot in Telegram: `/start`
|
||||
|
||||
{% image src="/docs/img/kiloclaw/telegram.png" alt="Connect account screen" width="800" caption="Telegram bot token entry" /%}
|
||||
|
||||
You can remove or replace a configured token at any time.
|
||||
|
||||
> ℹ️ **Info**
|
||||
> Advanced settings such as DM policy, allow lists, and groups can be configured in the OpenClaw Control UI after connecting.
|
||||
|
||||
### Discord
|
||||
|
||||
To connect Discord, you need a **Bot Token** from the [Discord Developer Portal](https://discord.com/developers/applications).
|
||||
|
||||
#### Create an Application and Bot
|
||||
|
||||
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and log in
|
||||
2. Click **New Application**, give it a name, and click **Create**
|
||||
3. Click **Bot** on the left sidebar
|
||||
4. Click **Add Bot** and confirm
|
||||
|
||||
#### Enable Privileged Intents
|
||||
|
||||
On the **Bot** page, scroll down to **Privileged Gateway Intents** and enable:
|
||||
|
||||
- **Message Content Intent** (required)
|
||||
- **Server Members Intent** (recommended — needed for role allowlists and name matching)
|
||||
- **Presence Intent** (optional)
|
||||
|
||||
#### Copy Your Bot Token
|
||||
|
||||
1. Scroll back up on the **Bot** page and click **Reset Token**
|
||||
|
||||
> 📝 **Note**
|
||||
> Despite the name, this generates your first token — nothing is being "reset."
|
||||
|
||||
2. Copy the token that appears and paste it into the **Discord Bot Token** field in your KiloClaw dashboard.
|
||||
|
||||
{% image src="/docs/img/kiloclaw/discord.png" alt="Connect account screen" width="800" caption="Discord bot token entry" /%}
|
||||
|
||||
Enter the token in the Settings tab and click **Save**. You can remove or replace a configured token at any time.
|
||||
|
||||
#### Generate an Invite URL and Add the Bot to Your Server
|
||||
|
||||
1. Click **OAuth2** on the sidebar
|
||||
2. Scroll down to **OAuth2 URL Generator** and enable:
|
||||
- `bot`
|
||||
- `applications.commands`
|
||||
3. A **Bot Permissions** section will appear below. Enable:
|
||||
- View Channels
|
||||
- Send Messages
|
||||
- Read Message History
|
||||
- Embed Links
|
||||
- Attach Files
|
||||
- Add Reactions (optional)
|
||||
4. Copy the generated URL at the bottom
|
||||
5. Paste it into your browser, select your server, and click **Continue**
|
||||
6. You should now see your bot in the Discord server
|
||||
|
||||
#### Start Chatting with the Bot
|
||||
|
||||
1. Right-click on the Bot in Discord and click **Message**
|
||||
2. DM the bot `/pair`
|
||||
3. You should get a response back with a pairing code
|
||||
4. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
|
||||
5. You should now be able to chat with the bot from Discord
|
||||
|
||||
### Slack
|
||||
|
||||
#### Step 1: Create a Slack App from the OpenClaw Manifest
|
||||
|
||||
1. Go to [Slack App Management](https://api.slack.com/apps) and click **Create New App** → **From a Manifest**
|
||||
2. Copy the manifest from the [OpenClaw docs](https://docs.openclaw.ai/channels/slack#manifest-and-scope-checklist)
|
||||
3. Paste the manifest JSON into Slack's manifest editor
|
||||
4. Customize the manifest before creating:
|
||||
- Rename the app to your preferred name wherever it appears
|
||||
- Update the slash command if desired (e.g., `/kiloclaw`)
|
||||
5. Click **Create**
|
||||
|
||||
#### Step 2: Generate Tokens
|
||||
|
||||
You need two tokens from Slack:
|
||||
|
||||
**App-Level Token**
|
||||
|
||||
1. In your Slack app settings, scroll down to **App-Level Tokens**
|
||||
2. Click **Generate Token**
|
||||
3. Add the `connections:write` scope
|
||||
4. Generate and copy the token (starts with `xapp-`)
|
||||
|
||||
**Bot User OAuth Token**
|
||||
|
||||
1. In the left sidebar, click **Install App**
|
||||
2. Install the app to your workspace
|
||||
3. Copy the **Bot User OAuth Token** (starts with `xoxb-`)
|
||||
|
||||
#### Step 3: Connect Slack to KiloClaw
|
||||
|
||||
1. In the [KiloClaw UI](https://app.kilo.ai/claw), find the Slack integration section (may show "not configured")
|
||||
2. Enter both tokens:
|
||||
- The `xapp-` app-level token
|
||||
- The `xoxb-` bot user OAuth token
|
||||
3. Click **Save**
|
||||
4. Scroll to the top of the KiloClaw UI and click **Redeploy**. Wait for the instance to come back up
|
||||
|
||||
#### Step 4: Pair Slack with KiloClaw
|
||||
|
||||
1. In Slack, DM the app and type your slash command (e.g., `/claw`) followed by anything — this triggers the pairing flow
|
||||
|
||||
> 📝 **Note**
|
||||
> The slash command is whatever you defined in the manifest. Any text after the command will work to trigger pairing.
|
||||
|
||||
2. The app will return a pairing code
|
||||
3. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
|
||||
4. You should now be able to chat with the bot from Slack
|
||||
|
||||
## Future Support
|
||||
|
||||
Additional platforms (such as WhatsApp) are planned for future releases. For the latest on supported platforms, refer to the [OpenClaw documentation](https://docs.openclaw.ai).
|
||||
|
||||
## Related
|
||||
|
||||
- [KiloClaw Overview](/docs/kiloclaw/overview)
|
||||
- [Dashboard Reference](/docs/kiloclaw/dashboard)
|
||||
- [Troubleshooting](/docs/kiloclaw/troubleshooting)
|
||||
- [KiloClaw Pricing](/docs/kiloclaw/pricing)
|
||||
- [OpenClaw Documentation](https://docs.openclaw.ai)
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: "Discord"
|
||||
description: "Connect your KiloClaw agent to Discord"
|
||||
---
|
||||
|
||||
# Discord
|
||||
|
||||
Connect your KiloClaw agent to Discord by creating a bot in the Discord Developer Portal and linking it to your KiloClaw dashboard.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Make sure you have a Discord server ready to add the bot to. If you don't have one, open Discord, scroll to the bottom of your server list, click **+**, choose **Create My Own**, then **For me and my friends**, and give it a name.
|
||||
|
||||
## Create an Application and Bot
|
||||
|
||||
1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and log in
|
||||
2. Click **New Application**, give it a name, and click **Create**
|
||||
|
||||
## Enable Privileged Intents
|
||||
|
||||
On the **Bot** page, scroll down to **Privileged Gateway Intents** and enable:
|
||||
|
||||
- **Message Content Intent** (required)
|
||||
- **Server Members Intent** (recommended — needed for role allowlists and name matching)
|
||||
- **Presence Intent** (optional)
|
||||
|
||||
## Generate an Invite URL and Add the Bot to Your Server
|
||||
|
||||
1. Click **OAuth2** on the sidebar
|
||||
2. Scroll down to **OAuth2 URL Generator** and enable:
|
||||
- `bot`
|
||||
- `applications.commands`
|
||||
3. A **Bot Permissions** section will appear below. Enable:
|
||||
- View Channels
|
||||
- Send Messages
|
||||
- Read Message History
|
||||
- Embed Links
|
||||
- Attach Files
|
||||
- Add Reactions (optional)
|
||||
4. Copy the generated URL at the bottom
|
||||
5. Paste it into your browser, select your server, and click **Continue**
|
||||
6. You should now see your bot in the Discord server
|
||||
|
||||
## Copy Your Bot Token
|
||||
|
||||
1. Go back to the **Bot** page on the left sidebar and click **Reset Token**
|
||||
|
||||
> 📝 **Note**
|
||||
> Despite the name, this generates your first token — nothing is being "reset."
|
||||
|
||||
2. Copy the token that appears and paste it into the **Discord Bot Token** field in your KiloClaw dashboard.
|
||||
|
||||
{% image src="/docs/img/kiloclaw/discord.png" alt="Connect account screen" width="800" caption="Discord bot token entry" /%}
|
||||
|
||||
Enter the token in the Settings tab and click **Save**. You can remove or replace a configured token at any time.
|
||||
|
||||
## Redeploy to Apply Changes
|
||||
|
||||
After saving your token, click **Redeploy** (the yellow button at the top of the KiloClaw dashboard) to apply the changes. The server will restart in about 30–45 seconds. Wait for the redeploy to complete before pairing.
|
||||
|
||||
## Start Chatting with the Bot
|
||||
|
||||
1. Right-click on the Bot in Discord and click **Message**
|
||||
2. DM the bot `/pair`
|
||||
3. You should get a response back with a pairing code
|
||||
4. Return to [app.kilo.ai/claw](https://app.kilo.ai/claw) and confirm the pairing code and approve
|
||||
5. You should now be able to chat with the bot from Discord
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Chat Platforms"
|
||||
description: "Connect your KiloClaw agent to Telegram, Discord, and Slack"
|
||||
---
|
||||
|
||||
# Chat Platforms
|
||||
|
||||
KiloClaw supports connecting your AI agent to messaging platforms so it can receive instructions and send responses directly in your chat apps. You can configure channels from the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard#channels), or from the OpenClaw Control UI after accessing your instance.
|
||||
|
||||
The general steps to connect any chat platform are:
|
||||
|
||||
1. Configure the channel token in Settings
|
||||
2. Redeploy the KiloClaw instance
|
||||
3. Initiate the pairing in the chat app
|
||||
4. Accept the pairing request in the [KiloClaw UI](https://app.kilo.ai/claw)
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
- [**Telegram**](/docs/kiloclaw/chat-platforms/telegram) — Connect via a BotFather bot token.
|
||||
- [**Discord**](/docs/kiloclaw/chat-platforms/discord) — Connect via a Discord Developer Portal bot token.
|
||||
- [**Slack**](/docs/kiloclaw/chat-platforms/slack) — Connect via a Slack app manifest with app-level and bot tokens.
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: "Slack"
|
||||
description: "Connect your KiloClaw agent to Slack"
|
||||
---
|
||||
|
||||
# Slack
|
||||
|
||||
Connect your KiloClaw agent to Slack by creating a Slack app from the OpenClaw manifest and linking it to your KiloClaw dashboard.
|
||||
|
||||
## Step 1: Create a Slack App from the OpenClaw Manifest
|
||||
|
||||
1. Go to [Slack App Management](https://api.slack.com/apps) and click **Create New App** → **From a Manifest**
|
||||
2. Copy the manifest from the [OpenClaw docs](https://docs.openclaw.ai/channels/slack#manifest-and-scope-checklist)
|
||||
3. Paste the manifest JSON into Slack's manifest editor
|
||||
4. Customize the manifest before creating:
|
||||
- Rename the app to your preferred name wherever it appears
|
||||
- Update the slash command if desired (e.g., `/kiloclaw`)
|
||||
5. Click **Create**
|
||||
|
||||
## Step 2: Generate Tokens
|
||||
|
||||
You need two tokens from Slack:
|
||||
|
||||
**App-Level Token**
|
||||
|
||||
1. In your Slack app settings, scroll down to **App-Level Tokens**
|
||||
2. Click **Generate Token**
|
||||
3. Add the `connections:write` scope
|
||||
4. Generate and copy the token (starts with `xapp-`)
|
||||
|
||||
**Bot User OAuth Token**
|
||||
|
||||
1. In the left sidebar, click **Install App**
|
||||
2. Install the app to your workspace
|
||||
3. Copy the **Bot User OAuth Token** (starts with `xoxb-`)
|
||||
|
||||
## Step 3: Connect Slack to KiloClaw
|
||||
|
||||
1. In the [KiloClaw UI](https://app.kilo.ai/claw), find the Slack integration section (may show "not configured")
|
||||
2. Enter both tokens:
|
||||
- The `xapp-` app-level token
|
||||
- The `xoxb-` bot user OAuth token
|
||||
3. Click **Save**
|
||||
4. Scroll to the top of the KiloClaw UI and click **Redeploy**. Wait for the instance to come back up
|
||||
|
||||
## Step 4: Pair Slack with KiloClaw
|
||||
|
||||
1. In Slack, DM the app and type your slash command (e.g., `/claw`) followed by anything — this triggers the pairing flow
|
||||
|
||||
> 📝 **Note**
|
||||
> The slash command is whatever you defined in the manifest. Any text after the command will work to trigger pairing.
|
||||
|
||||
2. The app will return a pairing code
|
||||
3. Return to [app.kilocode.ai/claw](https://app.kilocode.ai/claw) and confirm the pairing code and approve
|
||||
4. You should now be able to chat with the bot from Slack
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Telegram"
|
||||
description: "Connect your KiloClaw agent to Telegram"
|
||||
---
|
||||
|
||||
# Telegram
|
||||
|
||||
Connect your KiloClaw agent to Telegram by creating a bot via BotFather and linking it to your KiloClaw dashboard.
|
||||
|
||||
1. Open Telegram and search for [@BotFather](https://t.me/BotFather)
|
||||
2. Send `/newbot` and follow the prompts to create your bot
|
||||
3. Copy the **Bot Token** that BotFather gives you
|
||||
4. Go to the **Settings** tab on your [KiloClaw dashboard](/docs/kiloclaw/dashboard)
|
||||
5. Paste the token into the **Telegram Bot Token** field
|
||||
6. Click **Save**
|
||||
7. Redeploy your KiloClaw instance
|
||||
8. Send a direct message to your bot in Telegram: `/start`
|
||||
|
||||
{% image src="/docs/img/kiloclaw/telegram.png" alt="Connect account screen" width="800" caption="Telegram bot token entry" /%}
|
||||
|
||||
You can remove or replace a configured token at any time.
|
||||
|
||||
> ℹ️ **Info**
|
||||
> Advanced settings such as DM policy, allow lists, and groups can be configured in the OpenClaw Control UI after connecting.
|
||||
@@ -1,116 +0,0 @@
|
||||
---
|
||||
title: "OpenClaw Control UI"
|
||||
description: "Browser-based dashboard for managing your OpenClaw instance"
|
||||
---
|
||||
|
||||
# OpenClaw Control UI
|
||||
|
||||
The Control UI is a browser-based dashboard (built with Vite + Lit) served by the OpenClaw Gateway on the same port as the gateway itself (default: `http://localhost:18789/`). It connects via WebSocket and gives you real-time control over your agent, channels, sessions, and system configuration. For KiloClaw users, see [Accessing the Control UI](/docs/kiloclaw/dashboard#accessing-the-control-ui) to get started.
|
||||
|
||||
## Features
|
||||
|
||||
- **Chat** — Send messages, stream responses with live tool-call output, view history, and abort runs.
|
||||
- **Channels** — View the status of connected messaging platforms, scan QR codes for login, and edit per-channel config.
|
||||
- **Sessions** — List active sessions with thinking and verbose overrides.
|
||||
- **Cron Jobs** — Create, edit, enable/disable, run, and view history of scheduled tasks.
|
||||
- **Skills** — View status, enable/disable, install, and manage API keys for skills.
|
||||
- **Nodes** — List paired devices and their capabilities.
|
||||
- **Exec Approvals** — Edit gateway or node command allowlists. See [Exec Approvals](#exec-approvals) below.
|
||||
- **Config** — View and edit `openclaw.json` with schema-based form rendering and a raw JSON editor.
|
||||
- **Logs** — Live tail of gateway logs with filtering and export.
|
||||
- **Debug** — Status, health, model snapshots, event log, and manual RPC calls.
|
||||
- **Update** — Run package updates and restart the gateway.
|
||||
|
||||
For more details, please see the official [OpenClaw documentation](https://docs.openclaw.ai/web/control-ui).
|
||||
|
||||
{% callout type="warning" %}
|
||||
Do not use the **Update** feature in the Control UI to update KiloClaw. Use **Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy) instead. Updating via the Control UI will not apply the correct KiloClaw platform image and may break your instance.
|
||||
{% /callout %}
|
||||
|
||||
## Changing Models
|
||||
|
||||
The Control UI Chat tab doubles as a command line for model management. KiloClaw exposes 335+ models through the `kilocode` provider and you can browse and switch between them without leaving the chat.
|
||||
|
||||
| Command | Description |
|
||||
| ------------------------------------ | ------------------------------------------------------------------------------- |
|
||||
| `/model status` | View the currently active model and provider |
|
||||
| `/models kilocode` | Browse available models (paginated, 20 per page) |
|
||||
| `/models kilocode <page>` | Jump to a specific page (e.g. `/models kilocode 2`) |
|
||||
| `/model kilocode/<provider>/<model>` | Switch to a specific model (e.g. `/model kilocode/anthropic/claude-sonnet-4.6`) |
|
||||
| `/models kilocode all` | List every available model at once |
|
||||
|
||||
Each `/models` response includes helper text at the bottom with shortcuts for switching, paging, and listing all models.
|
||||
|
||||
To change the default model for all new sessions, edit `agents.defaults.model.primary` in your `openclaw.json` via **Config** in the Control UI (or the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#changing-the-model) for a quick dropdown pick).
|
||||
|
||||
For the full list of providers, advanced configuration, and CLI commands, see the [OpenClaw Model Providers documentation](https://docs.openclaw.ai/providers).
|
||||
|
||||
## Authentication
|
||||
|
||||
Auth is handled via token or password on the WebSocket handshake. Remote connections require one-time device pairing — the pairing request appears on the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#pairing-requests) or in the Control UI itself.
|
||||
|
||||
## Exec Approvals
|
||||
|
||||
Exec approvals are the safety interlock that controls which commands your agent can run on the host machine (gateway or node). By default, **all host exec requests are denied** — you must explicitly allowlist the commands you want your agent to run independently. This prevents accidental execution of destructive commands.
|
||||
|
||||
{% callout type="warning" %}
|
||||
The default security policy is `deny`. You must configure an allowlist before your agent can execute any host commands.
|
||||
{% /callout %}
|
||||
|
||||
### How It Works
|
||||
|
||||
Approvals are enforced locally on the execution host and sit on top of tool policy and elevated gating. The effective policy is always the **stricter** of `tools.exec.*` and the approvals defaults. Settings are stored in `~/.openclaw/exec-approvals.json` on the host.
|
||||
|
||||
### Security Policies
|
||||
|
||||
| Policy | Behavior |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| `deny` | Block all host exec requests (default) |
|
||||
| `allowlist` | Allow only commands matching the allowlist |
|
||||
| `full` | Allow everything (equivalent to elevated mode) |
|
||||
|
||||
### Ask Behavior
|
||||
|
||||
The `ask` setting controls when the user is prompted for approval:
|
||||
|
||||
| Setting | Behavior |
|
||||
| --------- | ------------------------------------------------------- |
|
||||
| `off` | Never prompt |
|
||||
| `on-miss` | Prompt only when the allowlist does not match (default) |
|
||||
| `always` | Prompt on every command |
|
||||
|
||||
If a prompt is required but no UI is reachable, the `askFallback` setting decides the outcome (`deny` by default).
|
||||
|
||||
### Allowlists
|
||||
|
||||
Allowlists are **per agent** — each agent has its own set of allowed command patterns. Patterns are case-insensitive globs that must resolve to binary paths (basename-only entries are ignored).
|
||||
|
||||
Example patterns:
|
||||
|
||||
```
|
||||
~/Projects/**/bin/rg
|
||||
~/.local/bin/*
|
||||
/opt/homebrew/bin/rg
|
||||
```
|
||||
|
||||
Each entry tracks last-used metadata (timestamp, command, resolved path) so you can audit and keep the list tidy.
|
||||
|
||||
### Approval Flow
|
||||
|
||||
When a command requires approval, the gateway broadcasts the request to connected operator clients. The approval dialog shows the command, arguments, working directory, agent ID, and resolved path. You can:
|
||||
|
||||
- **Allow once** — run the command now
|
||||
- **Allow always** — add to the allowlist and run
|
||||
- **Deny** — block the request
|
||||
|
||||
Approval prompts can also be forwarded to chat channels (Slack, Telegram, Discord, etc.) and resolved with `/approve`.
|
||||
|
||||
### Editing in the Control UI
|
||||
|
||||
Navigate to **Nodes > Exec Approvals** in the Control UI to edit defaults, per-agent overrides, and allowlists. Select a scope (Defaults or a specific agent), adjust the policy, add or remove allowlist patterns, then save.
|
||||
|
||||
## Related
|
||||
|
||||
- [KiloClaw Dashboard](/docs/kiloclaw/dashboard)
|
||||
- [KiloClaw Overview](/docs/kiloclaw/overview)
|
||||
- [Connecting Chat Platforms](/docs/kiloclaw/chat-platforms)
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "Changing Models"
|
||||
description: "Browse and switch models from the Control UI chat"
|
||||
---
|
||||
|
||||
# Changing Models
|
||||
|
||||
The Control UI Chat tab doubles as a command line for model management. KiloClaw exposes 335+ models through the `kilocode` provider and you can browse and switch between them without leaving the chat.
|
||||
|
||||
| Command | Description |
|
||||
| ------------------------------------ | ------------------------------------------------------------------------------- |
|
||||
| `/model status` | View the currently active model and provider |
|
||||
| `/models kilocode` | Browse available models (paginated, 20 per page) |
|
||||
| `/models kilocode <page>` | Jump to a specific page (e.g. `/models kilocode 2`) |
|
||||
| `/model kilocode/<provider>/<model>` | Switch to a specific model (e.g. `/model kilocode/anthropic/claude-sonnet-4.6`) |
|
||||
| `/models kilocode all` | List every available model at once |
|
||||
|
||||
Each `/models` response includes helper text at the bottom with shortcuts for switching, paging, and listing all models.
|
||||
|
||||
To change the default model for all new sessions, edit `agents.defaults.model.primary` in your `openclaw.json` via **Config** in the Control UI (or the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#changing-the-model) for a quick dropdown pick).
|
||||
|
||||
For the full list of providers, advanced configuration, and CLI commands, see the [OpenClaw Model Providers documentation](https://docs.openclaw.ai/providers).
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: "Exec Approvals"
|
||||
description: "Control which commands your KiloClaw agent can run on the host machine"
|
||||
---
|
||||
|
||||
# Exec Approvals
|
||||
|
||||
Exec approvals are the safety interlock that controls which commands your agent can run on the host machine (gateway or node). By default, **all host exec requests are denied** — you must explicitly allowlist the commands you want your agent to run independently. This prevents accidental execution of destructive commands.
|
||||
|
||||
{% callout type="warning" %}
|
||||
The default security policy is `deny`. You must configure an allowlist before your agent can execute any host commands.
|
||||
{% /callout %}
|
||||
|
||||
## How It Works
|
||||
|
||||
Approvals are enforced locally on the execution host and sit on top of tool policy and elevated gating. The effective policy is always the **stricter** of `tools.exec.*` and the approvals defaults. Settings are stored in `~/.openclaw/exec-approvals.json` on the host.
|
||||
|
||||
## Security Policies
|
||||
|
||||
| Policy | Behavior |
|
||||
| ----------- | ---------------------------------------------- |
|
||||
| `deny` | Block all host exec requests (default) |
|
||||
| `allowlist` | Allow only commands matching the allowlist |
|
||||
| `full` | Allow everything (equivalent to elevated mode) |
|
||||
|
||||
## Ask Behavior
|
||||
|
||||
The `ask` setting controls when the user is prompted for approval:
|
||||
|
||||
| Setting | Behavior |
|
||||
| --------- | ------------------------------------------------------- |
|
||||
| `off` | Never prompt |
|
||||
| `on-miss` | Prompt only when the allowlist does not match (default) |
|
||||
| `always` | Prompt on every command |
|
||||
|
||||
If a prompt is required but no UI is reachable, the `askFallback` setting decides the outcome (`deny` by default).
|
||||
|
||||
## Allowlists
|
||||
|
||||
Allowlists are **per agent** — each agent has its own set of allowed command patterns. Patterns are case-insensitive globs that must resolve to binary paths (basename-only entries are ignored).
|
||||
|
||||
Example patterns:
|
||||
|
||||
```
|
||||
~/Projects/**/bin/rg
|
||||
~/.local/bin/*
|
||||
/opt/homebrew/bin/rg
|
||||
```
|
||||
|
||||
Each entry tracks last-used metadata (timestamp, command, resolved path) so you can audit and keep the list tidy.
|
||||
|
||||
## Approval Flow
|
||||
|
||||
When a command requires approval, the gateway broadcasts the request to connected operator clients. The approval dialog shows the command, arguments, working directory, agent ID, and resolved path. You can:
|
||||
|
||||
- **Allow once** — run the command now
|
||||
- **Allow always** — add to the allowlist and run
|
||||
- **Deny** — block the request
|
||||
|
||||
Approval prompts can also be forwarded to chat channels (Slack, Telegram, Discord, etc.) and resolved with `/approve`.
|
||||
|
||||
## Editing in the Control UI
|
||||
|
||||
Navigate to **Nodes > Exec Approvals** in the Control UI to edit defaults, per-agent overrides, and allowlists. Select a scope (Defaults or a specific agent), adjust the policy, add or remove allowlist patterns, then save.
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "Control UI Overview"
|
||||
description: "Browser-based dashboard for managing your OpenClaw instance"
|
||||
---
|
||||
|
||||
# OpenClaw Control UI
|
||||
|
||||
The Control UI is a browser-based dashboard (built with Vite + Lit) served by the OpenClaw Gateway on the same port as the gateway itself (default: `http://localhost:18789/`). It connects via WebSocket and gives you real-time control over your agent, channels, sessions, and system configuration. For KiloClaw users, see [Accessing the Control UI](/docs/kiloclaw/dashboard#accessing-the-control-ui) to get started.
|
||||
|
||||
## Features
|
||||
|
||||
- **Chat** — Send messages, stream responses with live tool-call output, view history, and abort runs.
|
||||
- **Channels** — View the status of connected messaging platforms, scan QR codes for login, and edit per-channel config.
|
||||
- **Sessions** — List active sessions with thinking and verbose overrides.
|
||||
- **Cron Jobs** — Create, edit, enable/disable, run, and view history of scheduled tasks.
|
||||
- **Skills** — View status, enable/disable, install, and manage API keys for skills.
|
||||
- **Nodes** — List paired devices and their capabilities.
|
||||
- **Exec Approvals** — Edit gateway or node command allowlists. See [Exec Approvals](/docs/kiloclaw/control-ui/exec-approvals).
|
||||
- **Config** — View and edit `openclaw.json` with schema-based form rendering and a raw JSON editor.
|
||||
- **Logs** — Live tail of gateway logs with filtering and export.
|
||||
- **Debug** — Status, health, model snapshots, event log, and manual RPC calls.
|
||||
- **Update** — Run package updates and restart the gateway.
|
||||
|
||||
For more details, please see the official [OpenClaw documentation](https://docs.openclaw.ai/web/control-ui).
|
||||
|
||||
{% callout type="warning" %}
|
||||
Do not use the **Update** feature in the Control UI to update KiloClaw. Use **Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy) instead. Updating via the Control UI will not apply the correct KiloClaw platform image and may break your instance.
|
||||
{% /callout %}
|
||||
|
||||
## Authentication
|
||||
|
||||
Auth is handled via token or password on the WebSocket handshake. Remote connections require one-time device pairing — the pairing request appears on the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#pairing-requests) or in the Control UI itself.
|
||||
-6
@@ -45,9 +45,3 @@ To return to automatic updates:
|
||||
{% callout type="warning" %}
|
||||
Clearing a pin and running **Upgrade & Redeploy** will update your instance to the latest supported platform version. Review the changelog before upgrading to check for breaking changes.
|
||||
{% /callout %}
|
||||
|
||||
## Related
|
||||
|
||||
- [Dashboard Reference](/docs/kiloclaw/dashboard)
|
||||
- [KiloClaw Overview](/docs/kiloclaw/overview)
|
||||
- [Troubleshooting](/docs/kiloclaw/troubleshooting)
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "Development Tools"
|
||||
description: "Connect your KiloClaw agent to development platforms like GitHub and Google Workspace"
|
||||
---
|
||||
|
||||
# Development Tools
|
||||
|
||||
KiloClaw supports integrations with popular development platforms, allowing your agent to interact with repositories, code reviews, calendars, documents, and more — all autonomously.
|
||||
|
||||
## Available Integrations
|
||||
|
||||
- [**GitHub**](/docs/kiloclaw/development-tools/github) — Clone repositories, push commits, open pull requests, and leave code reviews.
|
||||
- [**Google Workspace**](/docs/kiloclaw/development-tools/google) — Access Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks, and more.
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "FAQ"
|
||||
description: "Frequently asked questions about KiloClaw"
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## How can I change my model?
|
||||
|
||||
You can change the model in two ways:
|
||||
|
||||
- **From chat** — Type `/model` in the Chat window within the OpenClaw Control UI to switch models directly.
|
||||
- **From the dashboard** — Go to [https://app.kilo.ai/claw](https://app.kilo.ai/claw), select the model you want, and click **Save**. No redeploy is needed.
|
||||
|
||||
## Can I access the filesystem?
|
||||
|
||||
You can access instance files in `/root/.openclaw/` directly from the [KiloClaw Dashboard](https://app.kilo.ai/claw). This is useful for examining or restoring config files. You can also interact with files through your OpenClaw agent using its built-in file tools.
|
||||
|
||||
## Can I access my KiloClaw via SSH?
|
||||
|
||||
For security reasons, SSH access is currently disabled for all KiloClaw instances. Our primary goal is to provide a secure environment for all users, and restricting direct SSH access is one of the many measures we take to ensure the platform remains safe and protected for everyone.
|
||||
|
||||
## How can I update my OpenClaw?
|
||||
|
||||
Do **not** click **Update Now** inside the OpenClaw Control UI — this is not supported for KiloClaw instances and may break your setup.
|
||||
|
||||
Updates are managed by the KiloClaw platform team to ensure stability. When a new version is available, it will be announced in the **Changelog** on your dashboard. To apply the update, click **Upgrade & Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy).
|
||||
+6
-12
@@ -1,37 +1,31 @@
|
||||
---
|
||||
title: "KiloClaw Pricing"
|
||||
title: "Pricing"
|
||||
description: "Pricing details for KiloClaw instances and model inference"
|
||||
---
|
||||
|
||||
# KiloClaw Pricing
|
||||
# Pricing
|
||||
|
||||
KiloClaw uses Kilo Gateway credits by default — if you route requests through BYOK, model usage is billed directly by your provider instead.
|
||||
|
||||
### Instance Hosting
|
||||
## Instance Hosting
|
||||
|
||||
KiloClaw hosting is **free during the beta period**. Each user gets a dedicated machine (2 shared vCPUs, 3 GB RAM, 10 GB SSD) at no cost.
|
||||
|
||||
> ℹ️ **Info**
|
||||
> Beta pricing is subject to change. Paid hosting tiers may be introduced after the beta period ends. Any changes will be announced in advance.
|
||||
|
||||
### Model Inference
|
||||
## Model Inference
|
||||
|
||||
Model usage is charged against your [Gateway credit balance](/docs/gateway/usage-and-billing). Costs vary by model — premium models like Claude Opus or GPT-5.4-pro cost more per token than smaller models.
|
||||
|
||||
### Free Models
|
||||
## Free Models
|
||||
|
||||
Several models are available at **no additional cost** to your Gateway balance. These are great for getting started or for tasks that don't need the most powerful models.
|
||||
|
||||
To see which models are currently free, check the [Kilo Leaderboard](https://kilo.ai/leaderboard#all-models) — free models are marked accordingly.
|
||||
|
||||
### Adding Credits
|
||||
## Adding Credits
|
||||
|
||||
You can add Gateway credits from your [Kilo account](https://app.kilo.ai). Credits are shared across all Kilo products (VSCode extension, CLI, Cloud Agents, and KiloClaw).
|
||||
|
||||
See [Adding Credits](/docs/getting-started/adding-credits) and [Gateway Usage and Billing](/docs/gateway/usage-and-billing) for details.
|
||||
|
||||
## Related
|
||||
|
||||
- [KiloClaw Overview](/docs/kiloclaw/overview)
|
||||
- [Connecting Chat Platforms](/docs/kiloclaw/chat-platforms)
|
||||
- [Gateway Usage and Billing](/docs/gateway/usage-and-billing)
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: "1Password Integration"
|
||||
description: "Connect your KiloClaw agent to 1Password to securely manage credentials"
|
||||
---
|
||||
|
||||
# 1Password Integration Guide
|
||||
|
||||
Connect your KiloClaw agent to 1Password to securely manage credentials. This allows your agent to fetch API keys or passwords without ever seeing them in plain text.
|
||||
|
||||
## Step 1: Create a Dedicated Vault
|
||||
|
||||
For maximum security, do not give the bot access to your personal vault.
|
||||
|
||||
1. Log in to your 1Password account.
|
||||
2. Create a **New Vault** (e.g., name it `Kilo-Agent-Vault`).
|
||||
3. Move only the specific items/keys you want the bot to use into this vault.
|
||||
|
||||
## Step 2: Generate a Service Account Token
|
||||
|
||||
1. Go to the [1Password Developer Portal](https://developer.1password.com/).
|
||||
2. Select **Service Accounts** and click **Create a Service Account**.
|
||||
3. **Important:** When prompted for permissions, select only the dedicated vault you created in Step 1.
|
||||
4. Copy the generated token (it will begin with `ops_`).
|
||||
|
||||
## Step 3: Configure KiloClaw
|
||||
|
||||
1. Navigate to your KiloClaw dashboard: [app.kilo.ai/claw](https://app.kilo.ai/claw).
|
||||
2. Go to **Settings > Tools** (or **Edit Files**).
|
||||
3. Paste your `ops_` token into the **1Password Setup** field.
|
||||
4. Click **Save**.
|
||||
|
||||
## Step 4: Activate the Integration
|
||||
|
||||
To apply the changes and inject the 1Password CLI into your environment:
|
||||
|
||||
1. Select **Upgrade to latest**.
|
||||
2. Perform a **Redeploy** to restart the agent with the new permissions active.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "AgentCard Integration"
|
||||
description: "Enable your KiloClaw agents to perform financial transactions with virtual debit cards"
|
||||
---
|
||||
|
||||
# AgentCard Integration
|
||||
|
||||
Enable your KiloClaw agents to perform financial transactions by creating and managing virtual debit cards. This integration allows for automated purchasing and expense management within set limits.
|
||||
|
||||
## AgentCard Setup
|
||||
|
||||
### 1. Create an AgentCard Account
|
||||
|
||||
Install the AgentCard CLI and sign up via your terminal:
|
||||
|
||||
```bash
|
||||
agent-cards signup
|
||||
```
|
||||
|
||||
### 2. Add a Payment Method
|
||||
|
||||
Link your funding source (via Stripe) to enable the creation of virtual cards:
|
||||
|
||||
```bash
|
||||
agent-cards payment-method
|
||||
```
|
||||
|
||||
### 3. Retrieve Your API Key
|
||||
|
||||
Open your local configuration file located at `~/.agent-cards/config.json`. Copy the value assigned to the `jwt` key.
|
||||
|
||||
### 4. Configure KiloClaw
|
||||
|
||||
1. Paste the **JWT** into the AgentCard setup field in your KiloClaw settings.
|
||||
2. Click **Save**.
|
||||
3. Use **Redeploy** to apply the new secret. Only use **Upgrade & Redeploy** if you also need the latest platform version.
|
||||
|
||||
## Available Tools
|
||||
|
||||
Once activated, your agent will have access to:
|
||||
|
||||
- `create_card`: Generate a new virtual debit card.
|
||||
- `list_cards`: View existing cards and their statuses.
|
||||
- `check_balance`: Monitor available funds.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Brave Search Integration"
|
||||
description: "Equip your KiloClaw agent with real-time web browsing via the Brave Search API"
|
||||
---
|
||||
|
||||
# Brave Search Integration
|
||||
|
||||
Equip your KiloClaw agent with real-time web browsing capabilities by integrating the Brave Search API. This allows the agent to fetch up-to-date information, perform market research, and verify facts beyond its training data.
|
||||
|
||||
## How to Generate a Brave Search API Key
|
||||
|
||||
To get started, you will need to obtain a "BSA" (Brave Search API) key from the Brave developer portal.
|
||||
|
||||
### 1. Access the Brave Search Dashboard
|
||||
|
||||
Go to [api.search.brave.com](https://api.search.brave.com) and sign in or create a developer account.
|
||||
|
||||
### 2. Choose a Subscription Plan
|
||||
|
||||
Brave Search API requires a paid subscription. Select the plan that fits your usage volume.
|
||||
|
||||
### 3. Create an API Key
|
||||
|
||||
Once your account is active, navigate to the **API Keys** section and click **"Create New Key."**
|
||||
|
||||
### 4. Copy the Key
|
||||
|
||||
Your key will typically begin with the prefix `BSA`. Copy this key immediately, as it may not be displayed again for security reasons.
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Tools"
|
||||
description: "Third-party tool integrations for your KiloClaw agent"
|
||||
---
|
||||
|
||||
# Tools
|
||||
|
||||
KiloClaw supports integrations with third-party tools that extend your agent's capabilities — from secure credential management to web search and financial transactions.
|
||||
|
||||
## Available Integrations
|
||||
|
||||
- [**1Password**](/docs/kiloclaw/tools/1password) — Securely manage credentials and let your agent fetch API keys or passwords without ever seeing them in plain text.
|
||||
- [**Brave Search**](/docs/kiloclaw/tools/brave-search) — Equip your agent with real-time web browsing via the Brave Search API.
|
||||
- [**AgentCard**](/docs/kiloclaw/tools/agentcard) — Enable your agent to perform financial transactions using virtual debit cards.
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
title: "Troubleshooting"
|
||||
description: "Common issues, diagnostics, and FAQ for KiloClaw instances"
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## OpenClaw Doctor
|
||||
|
||||
OpenClaw Doctor is the recommended first step when something isn't working. It runs diagnostics on your instance and automatically fixes common configuration issues.
|
||||
|
||||
To use it:
|
||||
|
||||
1. Make sure your instance is running
|
||||
2. Click **OpenClaw Doctor** on your [dashboard](/docs/kiloclaw/dashboard)
|
||||
3. Watch the output as it runs — results appear in real time
|
||||
|
||||
## Common Questions
|
||||
|
||||
### Does Redeploy reset my instance?
|
||||
|
||||
No. Redeploy does **not** delete your files, git repos, or cron jobs. It stops the machine, applies the latest platform image and your current configuration, and starts it again with the same persistent storage. Think of it as "update and restart."
|
||||
|
||||
### When should I use Restart OpenClaw vs Redeploy?
|
||||
|
||||
- **Restart OpenClaw** — Restarts just the OpenClaw process. The machine stays up. Use this for quick recovery from a process-level issue or when you want to apply openclaw config changes.
|
||||
- **Redeploy** — Stops and restarts the entire machine with the latest image and config. Use this when the changelog shows a redeploy hint, or after changing channel tokens or secrets.
|
||||
|
||||
### My bot isn't responding on Telegram/Discord/Slack
|
||||
|
||||
1. Check that the channel token is configured in [Settings](/docs/kiloclaw/dashboard#channels)
|
||||
2. Make sure you **Redeployed** or **Restarted OpenClaw** after saving tokens
|
||||
3. Check for pending [pairing requests](/docs/kiloclaw/chat-platforms#pairing-requests) — the user may need to be approved
|
||||
4. Try running **OpenClaw Doctor**
|
||||
|
||||
### Accessing and Restoring Config Files
|
||||
|
||||
You can directly access the files in /root/.openclaw/ on the [KiloClaw Dashboard](https://app.kilo.ai/claw) using the file browser of the edit files dialog. This can be a useful way to examine or update the config files (especially `openclaw.json`) if you run into an issue. There may also be backups in the form of `openclaw.bak` files that you can manually restore from if needed.
|
||||
|
||||
### The gateway shows "Crashed"
|
||||
|
||||
The OpenClaw process is automatically restarted when it crashes. Check the Gateway Process tab on your dashboard for the exit code and restart count. If it keeps crashing:
|
||||
|
||||
1. Run **OpenClaw Doctor**
|
||||
2. Try a **Redeploy** to apply the latest platform image
|
||||
3. If the issue persists, join the [Kilo Discord](https://kilo.ai/discord) and share details in the KiloClaw channel
|
||||
|
||||
### I changed the model but the agent is still using the old one
|
||||
|
||||
After selecting a new model, click **Save & Provision** to apply it. This refreshes the API key and saves the new model. You may also need to **Restart OpenClaw** for the change to take full effect.
|
||||
|
||||
## Gateway Process States
|
||||
|
||||
The Gateway Process tab shows the current state of the OpenClaw process inside your machine:
|
||||
|
||||
- **Running** — The process is up and handling requests
|
||||
- **Stopped** — The process is not running
|
||||
- **Starting** — The process is booting up
|
||||
- **Stopping** — The process is shutting down gracefully
|
||||
- **Crashed** — The process exited unexpectedly and will be automatically restarted
|
||||
- **Shutting Down** — The process is stopping as part of a machine stop or redeploy
|
||||
|
||||
## FAQ
|
||||
|
||||
### How can I change my model?
|
||||
|
||||
You can change the model in two ways:
|
||||
|
||||
- **From chat** — Type `/model` in the Chat window within the OpenClaw Control UI to switch models directly.
|
||||
- **From the dashboard** — Go to [https://app.kilo.ai/claw](https://app.kilo.ai/claw), select the model you want, and click **Save**. No redeploy is needed.
|
||||
|
||||
### Can I access the filesystem?
|
||||
|
||||
You can access instance files in `/root/.openclaw/` directly from the [KiloClaw Dashboard](https://app.kilo.ai/claw). This is useful for examining or restoring config files — see [Accessing and Restoring Config Files](#accessing-and-restoring-config-files) above. You can also interact with files through your OpenClaw agent using its built-in file tools.
|
||||
|
||||
### Can I access my KiloClaw via SSH?
|
||||
|
||||
For security reasons, SSH access is currently disabled for all KiloClaw instances. Our primary goal is to provide a secure environment for all users, and restricting direct SSH access is one of the many measures we take to ensure the platform remains safe and protected for everyone.
|
||||
|
||||
### Can I install tailscale on my KiloClaw instance?
|
||||
|
||||
Not at this time.
|
||||
|
||||
### Can I update the version of Node on my instance?
|
||||
|
||||
Not at this time.
|
||||
|
||||
### How do I upgrade the OpenClaw version? Can I upgrade it myself?
|
||||
|
||||
Updates are managed by the KiloClaw platform team to ensure stability and dependency availability. When a new version is available, it will be announced in the **Changelog** on your dashboard.
|
||||
|
||||
To apply the update, click **Upgrade & Redeploy** from the [KiloClaw Dashboard](https://app.kilo.ai/claw). Do **not** click **Update Now** inside the OpenClaw Control UI — this is not supported for KiloClaw instances and may break your setup.
|
||||
|
||||
If you need to roll back, use the [version pinning](/docs/kiloclaw/version-pinning) dialog in the Settings tab.
|
||||
|
||||
## Architecture Notes
|
||||
|
||||
For advanced users — how KiloClaw instances are structured:
|
||||
|
||||
- **Dedicated machine** — Each user gets their own machine and persistent volume. There is no shared infrastructure between users.
|
||||
- **Region-pinned storage** — Your persistent volume stays in the region where your instance was originally created.
|
||||
- **Network isolation** — OpenClaw binds to loopback only; external traffic is proxied through a Kilo controller.
|
||||
- **Per-user authentication** — The gateway token is derived per-user for authenticating requests to your machine.
|
||||
- **Encryption at rest** — Sensitive data (API keys, channel tokens) is encrypted at rest in the machine configuration.
|
||||
|
||||
## Related
|
||||
|
||||
- [KiloClaw Overview](/docs/kiloclaw/overview)
|
||||
- [Dashboard Reference](/docs/kiloclaw/dashboard)
|
||||
- [Connecting Chat Platforms](/docs/kiloclaw/chat-platforms)
|
||||
- [KiloClaw Pricing](/docs/kiloclaw/pricing)
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Architecture Notes"
|
||||
description: "How KiloClaw instances are structured"
|
||||
---
|
||||
|
||||
# Architecture Notes
|
||||
|
||||
For advanced users — how KiloClaw instances are structured:
|
||||
|
||||
- **Dedicated machine** — Each user gets their own machine and persistent volume. There is no shared infrastructure between users.
|
||||
- **Region-pinned storage** — Your persistent volume stays in the region where your instance was originally created.
|
||||
- **Network isolation** — OpenClaw binds to loopback only; external traffic is proxied through a Kilo controller.
|
||||
- **Per-user authentication** — The gateway token is derived per-user for authenticating requests to your machine.
|
||||
- **Encryption at rest** — Sensitive data (API keys, channel tokens) is encrypted at rest in the machine configuration.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: "Common Questions"
|
||||
description: "Answers to common KiloClaw troubleshooting questions"
|
||||
---
|
||||
|
||||
# Common Questions
|
||||
|
||||
## OpenClaw Doctor
|
||||
|
||||
OpenClaw Doctor is the recommended first step when something isn't working. It runs diagnostics on your instance and automatically fixes common configuration issues.
|
||||
|
||||
To use it:
|
||||
|
||||
1. Make sure your instance is running
|
||||
2. Click **OpenClaw Doctor** on your [dashboard](/docs/kiloclaw/dashboard)
|
||||
3. Watch the output as it runs — results appear in real time
|
||||
|
||||
## Does Redeploy reset my instance?
|
||||
|
||||
No. Redeploy does **not** delete your files, git repos, or cron jobs. It stops the machine, applies the latest platform image and your current configuration, and starts it again with the same persistent storage. Think of it as "update and restart."
|
||||
|
||||
## When should I use Restart OpenClaw vs Redeploy?
|
||||
|
||||
- **Restart OpenClaw** — Restarts just the OpenClaw process. The machine stays up. Use this for quick recovery from a process-level issue or when you want to apply openclaw config changes.
|
||||
- **Redeploy** — Stops and restarts the entire machine with the latest image and config. Use this when the changelog shows a redeploy hint, or after changing channel tokens or secrets.
|
||||
|
||||
## My bot isn't responding on Telegram/Discord/Slack
|
||||
|
||||
1. Check that the channel token is configured in [Settings](/docs/kiloclaw/dashboard#channels)
|
||||
2. Make sure you **Redeployed** or **Restarted OpenClaw** after saving tokens
|
||||
3. Check for pending pairing requests — the user may need to be approved
|
||||
4. Try running **OpenClaw Doctor**
|
||||
|
||||
## Accessing and Restoring Config Files
|
||||
|
||||
You can directly access the files in `/root/.openclaw/` on the [KiloClaw Dashboard](https://app.kilo.ai/claw) using the file browser of the edit files dialog. This can be a useful way to examine or update the config files (especially `openclaw.json`) if you run into an issue. There may also be backups in the form of `openclaw.bak` files that you can manually restore from if needed.
|
||||
|
||||
## The gateway shows "Crashed"
|
||||
|
||||
The OpenClaw process is automatically restarted when it crashes. Check the Gateway Process tab on your dashboard for the exit code and restart count. If it keeps crashing:
|
||||
|
||||
1. Run **OpenClaw Doctor**
|
||||
2. Try a **Redeploy** to apply the latest platform image
|
||||
3. If the issue persists, join the [Kilo Discord](https://kilo.ai/discord) and share details in the KiloClaw channel
|
||||
|
||||
## I changed the model but the agent is still using the old one
|
||||
|
||||
After selecting a new model, click **Save & Provision** to apply it. This refreshes the API key and saves the new model. You may also need to **Restart OpenClaw** for the change to take full effect.
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "FAQ"
|
||||
description: "Frequently asked questions about KiloClaw"
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## How can I change my model?
|
||||
|
||||
You can change the model in two ways:
|
||||
|
||||
- **From chat** — Type `/model` in the Chat window within the OpenClaw Control UI to switch models directly.
|
||||
- **From the dashboard** — Go to [https://app.kilo.ai/claw](https://app.kilo.ai/claw), select the model you want, and click **Save**. No redeploy is needed.
|
||||
|
||||
## Can I access the filesystem?
|
||||
|
||||
You can access instance files in `/root/.openclaw/` directly from the [KiloClaw Dashboard](https://app.kilo.ai/claw). This is useful for examining or restoring config files. You can also interact with files through your OpenClaw agent using its built-in file tools.
|
||||
|
||||
## Can I access my KiloClaw via SSH?
|
||||
|
||||
For security reasons, SSH access is currently disabled for all KiloClaw instances. Our primary goal is to provide a secure environment for all users, and restricting direct SSH access is one of the many measures we take to ensure the platform remains safe and protected for everyone.
|
||||
|
||||
## How can I update my OpenClaw?
|
||||
|
||||
Do **not** click **Update Now** inside the OpenClaw Control UI — this is not supported for KiloClaw instances and may break your setup.
|
||||
|
||||
Updates are managed by the KiloClaw platform team to ensure stability. When a new version is available, it will be announced in the **Changelog** on your dashboard. To apply the update, click **Upgrade & Redeploy** from the [KiloClaw Dashboard](/docs/kiloclaw/dashboard#redeploy).
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: "Gateway Process States"
|
||||
description: "Understanding KiloClaw gateway process states"
|
||||
---
|
||||
|
||||
# Gateway Process States
|
||||
|
||||
The Gateway Process tab shows the current state of the OpenClaw process inside your machine:
|
||||
|
||||
- **Running** — The process is up and handling requests
|
||||
- **Stopped** — The process is not running
|
||||
- **Starting** — The process is booting up
|
||||
- **Stopping** — The process is shutting down gracefully
|
||||
- **Crashed** — The process exited unexpectedly and will be automatically restarted
|
||||
- **Shutting Down** — The process is stopping as part of a machine stop or redeploy
|
||||
Reference in New Issue
Block a user