Files
openclaw/docs/start/onboarding.md

92 lines
3.2 KiB
Markdown
Raw Normal View History

2025-12-14 03:59:24 +00:00
---
2026-01-30 03:15:10 +01:00
summary: "First-run onboarding flow for OpenClaw (macOS app)"
2025-12-14 03:59:24 +00:00
read_when:
- Designing the macOS onboarding assistant
2026-01-08 23:06:56 +01:00
- Implementing auth or identity setup
title: "Onboarding (macOS App)"
sidebarTitle: "Onboarding: macOS App"
2025-12-14 03:59:24 +00:00
---
2026-01-31 21:13:13 +09:00
# Onboarding (macOS App)
2025-12-14 03:59:24 +00:00
2026-01-08 23:06:56 +01:00
This doc describes the **current** firstrun onboarding flow. The goal is a
smooth “day 0” experience: pick where the Gateway runs, connect auth, run the
wizard, and let the agent bootstrap itself.
For a general overview of onboarding paths, see [Onboarding Overview](/start/onboarding-overview).
2025-12-14 03:59:24 +00:00
<Steps>
<Step title="Approve macOS warning">
<Frame>
<img src="/assets/macos-onboarding/01-macos-warning.jpeg" alt="" />
</Frame>
</Step>
<Step title="Approve find local networks">
<Frame>
<img src="/assets/macos-onboarding/02-local-networks.jpeg" alt="" />
</Frame>
</Step>
<Step title="Welcome and security notice">
<Frame caption="Read the security notice displayed and decide accordingly">
<img src="/assets/macos-onboarding/03-security-notice.png" alt="" />
</Frame>
Security trust model:
- By default, OpenClaw is a personal agent: one trusted operator boundary.
- Shared/multi-user setups require lock-down (split trust boundaries, keep tool access minimal, and follow [Security](/gateway/security)).
- Local onboarding now defaults new configs to `tools.profile: "coding"` so fresh local setups keep filesystem/runtime tools without forcing the unrestricted `full` profile.
- If hooks/webhooks or other untrusted content feeds are enabled, use a strong modern model tier and keep strict tool policy/sandboxing.
</Step>
<Step title="Local vs Remote">
<Frame>
<img src="/assets/macos-onboarding/04-choose-gateway.png" alt="" />
</Frame>
2025-12-14 03:59:24 +00:00
2026-01-08 23:06:56 +01:00
Where does the **Gateway** run?
2025-12-14 03:59:24 +00:00
- **This Mac (Local only):** onboarding can configure auth and write credentials
2026-01-08 23:06:56 +01:00
locally.
- **Remote (over SSH/Tailnet):** onboarding does **not** configure local auth;
2026-01-08 23:06:56 +01:00
credentials must exist on the gateway host.
- **Configure later:** skip setup and leave the app unconfigured.
2025-12-14 03:59:24 +00:00
<Tip>
**Gateway auth tip:**
- The wizard now generates a **token** even for loopback, so local WS clients must authenticate.
- If you disable auth, any local process can connect; use that only on fully trusted machines.
2026-01-08 23:06:56 +01:00
- Use a **token** for multimachine access or nonloopback binds.
</Tip>
</Step>
<Step title="Permissions">
<Frame caption="Choose what permissions do you want to give OpenClaw">
<img src="/assets/macos-onboarding/05-permissions.png" alt="" />
</Frame>
2026-01-05 06:46:20 +01:00
2026-01-08 23:06:56 +01:00
Onboarding requests TCC permissions needed for:
2026-01-05 06:46:20 +01:00
- Automation (AppleScript)
2026-01-08 23:06:56 +01:00
- Notifications
- Accessibility
- Screen Recording
- Microphone
- Speech Recognition
- Camera
- Location
2026-02-05 12:14:45 -05:00
</Step>
<Step title="CLI">
<Info>This step is optional</Info>
The app can install the global `openclaw` CLI via npm/pnpm so terminal
workflows and launchd tasks work out of the box.
2026-02-05 12:14:45 -05:00
</Step>
<Step title="Onboarding Chat (dedicated session)">
After setup, the app opens a dedicated onboarding chat session so the agent can
introduce itself and guide next steps. This keeps firstrun guidance separate
from your normal conversation. See [Bootstrapping](/start/bootstrapping) for
what happens on the gateway host during the first agent run.
2026-02-05 12:14:45 -05:00
</Step>
</Steps>