Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Gateway là máy chủ WebSocket của OpenClaw (kênh, node, phiên, hook). Các lệnh con trên trang này nằm dưới openclaw gateway ….

Bonjour discovery

Thiết lập mDNS cục bộ + DNS-SD diện rộng.

Discovery overview

Cách OpenClaw quảng bá và tìm Gateway.

Configuration

Các khóa cấu hình Gateway cấp cao nhất.

​
Chạy Gateway

Chạy một tiến trình Gateway cục bộ: 
openclaw gateway
Bí danh chạy ở nền trước: 
openclaw gateway run
  • Theo mặc định, Gateway từ chối khởi động trừ khi gateway.mode=local được đặt trong ~/.openclaw/openclaw.json. Dùng --allow-unconfigured cho các lần chạy ad-hoc/phát triển.
  • openclaw onboard --mode local và openclaw setup được kỳ vọng sẽ ghi gateway.mode=local. Nếu tệp tồn tại nhưng thiếu gateway.mode, hãy xem đó là cấu hình bị hỏng hoặc bị ghi đè và sửa nó thay vì ngầm giả định chế độ local.
  • Nếu tệp tồn tại và thiếu gateway.mode, Gateway xem đó là hư hại cấu hình đáng ngờ và từ chối “đoán local” thay bạn.
  • Việc bind vượt ra ngoài loopback mà không có xác thực sẽ bị chặn (rào chắn an toàn).
  • SIGUSR1 kích hoạt khởi động lại trong tiến trình khi được cho phép (commands.restart được bật theo mặc định; đặt commands.restart: false để chặn khởi động lại thủ công, trong khi công cụ Gateway/cấu hình apply/update vẫn được phép).
  • Các handler SIGINT/SIGTERM dừng tiến trình Gateway, nhưng chúng không khôi phục bất kỳ trạng thái terminal tùy chỉnh nào. Nếu bạn bọc CLI bằng TUI hoặc đầu vào raw-mode, hãy khôi phục terminal trước khi thoát.

​
Tùy chọn

​
--port <port>
number
Cổng WebSocket (mặc định đến từ cấu hình/env; thường là 18789).
​
--bind <loopback|lan|tailnet|auto|custom>
string
Chế độ bind của listener.
​
--auth <token|password>
string
Ghi đè chế độ xác thực.
​
--token <token>
string
Ghi đè token (đồng thời đặt OPENCLAW_GATEWAY_TOKEN cho tiến trình).
​
--password <password>
string
Ghi đè mật khẩu.
​
--password-file <path>
string
Đọc mật khẩu Gateway từ một tệp.
​
--tailscale <off|serve|funnel>
string
Công khai Gateway qua Tailscale.
​
--tailscale-reset-on-exit
boolean
Đặt lại cấu hình Tailscale serve/funnel khi tắt.
​
--allow-unconfigured
boolean
Cho phép khởi động Gateway mà không có gateway.mode=local trong cấu hình. Chỉ bỏ qua chốt bảo vệ khởi động cho bootstrap ad-hoc/phát triển; không ghi hoặc sửa tệp cấu hình.
​
--dev
boolean
Tạo cấu hình phát triển + workspace nếu còn thiếu (bỏ qua BOOTSTRAP.md).
​
--reset
boolean
Đặt lại cấu hình phát triển + thông tin xác thực + phiên + workspace (yêu cầu --dev).
​
--force
boolean
Dừng mọi listener hiện có trên cổng đã chọn trước khi khởi động.
​
--verbose
boolean
Log chi tiết.
​
--cli-backend-logs
boolean
Chỉ hiển thị log backend CLI trong console (và bật stdout/stderr).
​
--ws-log <auto|full|compact>
string
mặc định:"auto"
Kiểu log WebSocket.
​
--compact
boolean
Bí danh cho --ws-log compact.
​
--raw-stream
boolean
Ghi log các sự kiện luồng mô hình thô vào jsonl.
​
--raw-stream-path <path>
string
Đường dẫn jsonl cho luồng thô.

​
Khởi động lại Gateway

openclaw gateway restart
openclaw gateway restart --safe
openclaw gateway restart --safe --skip-deferral
openclaw gateway restart --force
openclaw gateway restart --safe yêu cầu Gateway đang chạy preflight công việc OpenClaw đang hoạt động trước khi khởi động lại. Nếu các thao tác trong hàng đợi, việc gửi phản hồi, các lần chạy nhúng hoặc các lần chạy tác vụ đang hoạt động, Gateway sẽ báo cáo các yếu tố chặn, gộp các yêu cầu khởi động lại an toàn trùng lặp và khởi động lại sau khi công việc đang hoạt động đã thoát hết. restart thông thường giữ hành vi service-manager hiện có để tương thích. Chỉ dùng --force khi bạn chủ ý muốn đường dẫn ghi đè tức thì. openclaw gateway restart --safe --skip-deferral chạy cùng quá trình khởi động lại phối hợp có nhận biết OpenClaw như --safe, nhưng bỏ qua cổng hoãn do công việc đang hoạt động để Gateway phát lệnh khởi động lại ngay cả khi có báo cáo yếu tố chặn. Dùng nó làm lối thoát cho người vận hành khi việc hoãn bị ghim bởi một lần chạy tác vụ bị kẹt và chỉ dùng --safe sẽ chờ vô thời hạn. --skip-deferral yêu cầu --safe.
--password nội tuyến có thể bị lộ trong danh sách tiến trình cục bộ. Ưu tiên --password-file, env, hoặc gateway.auth.password dựa trên SecretRef.

​
Profiling khởi động

  • Đặt OPENCLAW_GATEWAY_STARTUP_TRACE=1 để ghi log thời gian từng pha trong quá trình khởi động Gateway, bao gồm độ trễ eventLoopMax theo từng pha và thời gian bảng tra cứu Plugin cho installed-index, manifest registry, startup planning và owner-map.
  • Đặt OPENCLAW_DIAGNOSTICS=timeline với OPENCLAW_DIAGNOSTICS_TIMELINE_PATH=<path> để ghi một timeline chẩn đoán khởi động JSONL theo best-effort cho các harness QA bên ngoài. Bạn cũng có thể bật cờ bằng diagnostics.flags: ["timeline"] trong cấu hình; đường dẫn vẫn được cung cấp qua env. Thêm OPENCLAW_DIAGNOSTICS_EVENT_LOOP=1 để bao gồm mẫu event-loop.
  • Chạy pnpm test:startup:gateway -- --runs 5 --warmup 1 để benchmark khởi động Gateway. Benchmark ghi nhận đầu ra đầu tiên của tiến trình, /healthz, /readyz, thời gian startup trace, độ trễ event-loop và chi tiết thời gian bảng tra cứu Plugin.

​
Truy vấn một Gateway đang chạy

Tất cả lệnh truy vấn dùng WebSocket RPC.
  • Mặc định: dễ đọc cho người dùng (có màu trong TTY).
  • --json: JSON đọc được bằng máy (không có kiểu dáng/spinner).
  • --no-color (hoặc NO_COLOR=1): tắt ANSI trong khi vẫn giữ bố cục dành cho người đọc.
Khi bạn đặt --url, CLI không fallback về thông tin xác thực trong cấu hình hoặc môi trường. Truyền --token hoặc --password một cách tường minh. Thiếu thông tin xác thực tường minh là lỗi.

​
gateway health

openclaw gateway health --url ws://127.0.0.1:18789
Endpoint HTTP /healthz là probe kiểm tra tiến trình còn sống: nó trả về khi máy chủ có thể trả lời HTTP. Endpoint HTTP /readyz nghiêm ngặt hơn và vẫn đỏ trong khi các sidecar Plugin khởi động, kênh hoặc hook đã cấu hình vẫn đang ổn định. Các phản hồi readiness chi tiết cục bộ hoặc đã xác thực bao gồm một khối chẩn đoán eventLoop với độ trễ event-loop, mức sử dụng event-loop, tỷ lệ lõi CPU và cờ degraded.

​
gateway usage-cost

Lấy tóm tắt usage-cost từ log phiên. 
openclaw gateway usage-cost
openclaw gateway usage-cost --days 7
openclaw gateway usage-cost --json
​
--days <days>
number
mặc định:"30"
Số ngày cần bao gồm.

​
gateway stability

Lấy bộ ghi chẩn đoán stability gần đây từ một Gateway đang chạy. 
openclaw gateway stability
openclaw gateway stability --type payload.large
openclaw gateway stability --bundle latest
openclaw gateway stability --bundle latest --export
openclaw gateway stability --json
​
--limit <limit>
number
mặc định:"25"
Số sự kiện gần đây tối đa cần bao gồm (tối đa 1000).
​
--type <type>
string
Lọc theo loại sự kiện chẩn đoán, chẳng hạn như payload.large hoặc diagnostic.memory.pressure.
​
--since-seq <seq>
number
Chỉ bao gồm các sự kiện sau một số thứ tự chẩn đoán.
​
--bundle [path]
string
Đọc bundle stability đã lưu thay vì gọi Gateway đang chạy. Dùng --bundle latest (hoặc chỉ --bundle) cho bundle mới nhất trong thư mục trạng thái, hoặc truyền trực tiếp đường dẫn JSON của bundle.
​
--export
boolean
Ghi một zip chẩn đoán hỗ trợ có thể chia sẻ thay vì in chi tiết stability.
​
--output <path>
string
Đường dẫn đầu ra cho --export.
  • Bản ghi giữ lại metadata vận hành: tên sự kiện, số lượng, kích thước byte, chỉ số bộ nhớ, trạng thái hàng đợi/phiên, tên kênh/Plugin và tóm tắt phiên đã biên tập. Chúng không giữ văn bản chat, body Webhook, đầu ra công cụ, body yêu cầu hoặc phản hồi thô, token, cookie, giá trị bí mật, hostname hoặc id phiên thô. Đặt diagnostics.enabled: false để tắt hoàn toàn bộ ghi.
  • Khi Gateway thoát do lỗi nghiêm trọng, timeout khi tắt và lỗi khởi động sau restart, OpenClaw ghi cùng snapshot chẩn đoán vào ~/.openclaw/logs/stability/openclaw-stability-*.json khi bộ ghi có sự kiện. Kiểm tra bundle mới nhất bằng openclaw gateway stability --bundle latest; --limit, --type và --since-seq cũng áp dụng cho đầu ra bundle.

​
gateway diagnostics export

Ghi một zip chẩn đoán cục bộ được thiết kế để đính kèm vào báo cáo lỗi. Để biết mô hình quyền riêng tư và nội dung bundle, xem Diagnostics Export. 
openclaw gateway diagnostics export
openclaw gateway diagnostics export --output openclaw-diagnostics.zip
openclaw gateway diagnostics export --json
​
--output <path>
string
Đường dẫn zip đầu ra. Mặc định là một bản export hỗ trợ trong thư mục trạng thái.
​
--log-lines <count>
number
mặc định:"5000"
Số dòng log đã làm sạch tối đa cần bao gồm.
​
--log-bytes <bytes>
number
mặc định:"1000000"
Số byte log tối đa cần kiểm tra.
​
--url <url>
string
URL WebSocket của Gateway cho snapshot health.
​
--token <token>
string
Token Gateway cho snapshot health.
​
--password <password>
string
Mật khẩu Gateway cho snapshot health.
​
--timeout <ms>
number
mặc định:"3000"
Timeout cho snapshot trạng thái/health.
​
--no-stability-bundle
boolean
Bỏ qua tra cứu bundle stability đã lưu.
​
--json
boolean
In đường dẫn đã ghi, kích thước và manifest dưới dạng JSON.
Bản export chứa manifest, tóm tắt Markdown, hình dạng cấu hình, chi tiết cấu hình đã làm sạch, tóm tắt log đã làm sạch, snapshot trạng thái/health Gateway đã làm sạch và bundle stability mới nhất khi có. Nó được thiết kế để chia sẻ. Nó giữ lại các chi tiết vận hành giúp gỡ lỗi, chẳng hạn như các trường log OpenClaw an toàn, tên subsystem, mã trạng thái, thời lượng, chế độ đã cấu hình, cổng, id Plugin, id provider, thiết lập tính năng không bí mật và thông điệp log vận hành đã biên tập. Nó bỏ qua hoặc biên tập văn bản chat, body Webhook, đầu ra công cụ, thông tin xác thực, cookie, định danh tài khoản/tin nhắn, văn bản prompt/chỉ dẫn, hostname và giá trị bí mật. Khi một thông điệp kiểu LogTape trông giống văn bản payload người dùng/chat/công cụ, bản export chỉ giữ lại việc một thông điệp đã bị bỏ qua cộng với số byte của nó.

​
gateway status

gateway status hiển thị dịch vụ Gateway (launchd/systemd/schtasks) cộng với một probe tùy chọn về khả năng kết nối/xác thực. 
openclaw gateway status
openclaw gateway status --json
openclaw gateway status --require-rpc
​
--url <url>
string
Thêm mục tiêu thăm dò rõ ràng. Remote đã cấu hình + localhost vẫn được thăm dò.
​
--token <token>
string
Xác thực bằng token cho thăm dò.
​
--password <password>
string
Xác thực bằng mật khẩu cho thăm dò.
​
--timeout <ms>
number
mặc định:"10000"
Thời gian chờ thăm dò.
​
--no-probe
boolean
Bỏ qua thăm dò kết nối (chế độ xem chỉ dịch vụ).
​
--deep
boolean
Quét cả các dịch vụ cấp hệ thống.
​
--require-rpc
boolean
Nâng cấp thăm dò kết nối mặc định thành thăm dò đọc và thoát với mã khác 0 khi thăm dò đọc đó thất bại. Không thể kết hợp với --no-probe.
  • gateway status vẫn khả dụng cho chẩn đoán ngay cả khi cấu hình CLI cục bộ bị thiếu hoặc không hợp lệ.
  • gateway status mặc định chứng minh trạng thái dịch vụ, kết nối WebSocket và khả năng xác thực hiển thị tại thời điểm bắt tay. Nó không chứng minh các thao tác đọc/ghi/quản trị.
  • Các thăm dò chẩn đoán không thay đổi trạng thái đối với xác thực thiết bị lần đầu: chúng tái sử dụng token thiết bị đã lưu trong bộ nhớ đệm khi có sẵn, nhưng không tạo danh tính thiết bị CLI mới hoặc bản ghi ghép đôi thiết bị chỉ đọc mới chỉ để kiểm tra trạng thái.
  • gateway status phân giải các SecretRef xác thực đã cấu hình cho xác thực thăm dò khi có thể.
  • Nếu một SecretRef xác thực bắt buộc không được phân giải trong đường dẫn lệnh này, gateway status --json báo cáo rpc.authWarning khi kết nối/xác thực thăm dò thất bại; truyền rõ ràng --token/--password hoặc phân giải nguồn bí mật trước.
  • Nếu thăm dò thành công, các cảnh báo auth-ref chưa phân giải sẽ bị ẩn để tránh cảnh báo sai.
  • Dùng --require-rpc trong script và tự động hóa khi một dịch vụ đang lắng nghe là chưa đủ và bạn cũng cần các lệnh gọi RPC phạm vi đọc ở trạng thái lành mạnh.
  • --deep thêm quét nỗ lực tối đa để tìm các bản cài đặt launchd/systemd/schtasks bổ sung. Khi phát hiện nhiều dịch vụ giống Gateway, đầu ra cho người dùng in các gợi ý dọn dẹp và cảnh báo rằng hầu hết thiết lập nên chạy một Gateway trên mỗi máy.
  • --deep cũng báo cáo một lần bàn giao khởi động lại gần đây của trình giám sát Gateway khi tiến trình dịch vụ thoát sạch để trình giám sát bên ngoài khởi động lại.
  • --deep chạy xác thực cấu hình ở chế độ nhận biết Plugin (pluginValidation: "full") và hiển thị các cảnh báo manifest Plugin đã cấu hình (ví dụ thiếu siêu dữ liệu cấu hình kênh) để các kiểm tra smoke cài đặt và cập nhật bắt được chúng. gateway status mặc định giữ đường dẫn chỉ đọc nhanh bỏ qua xác thực Plugin.
  • Đầu ra cho người dùng bao gồm đường dẫn nhật ký tệp đã phân giải cùng ảnh chụp nhanh đường dẫn/tính hợp lệ cấu hình CLI-so-với-dịch-vụ để giúp chẩn đoán lệch profile hoặc state-dir.
  • Trên các bản cài đặt Linux systemd, kiểm tra lệch xác thực dịch vụ đọc cả giá trị Environment= và EnvironmentFile= từ unit (bao gồm %h, đường dẫn có dấu nháy, nhiều tệp và các tệp tùy chọn -).
  • Kiểm tra lệch phân giải SecretRef gateway.auth.token bằng env thời gian chạy đã hợp nhất (env lệnh dịch vụ trước, sau đó dự phòng sang env tiến trình).
  • Nếu xác thực token không thực sự hoạt động (gateway.auth.mode rõ ràng là password/none/trusted-proxy, hoặc mode chưa đặt trong đó mật khẩu có thể thắng và không có ứng viên token nào có thể thắng), kiểm tra lệch-token bỏ qua phân giải token cấu hình.

​
gateway probe

gateway probe là lệnh “gỡ lỗi mọi thứ”. Nó luôn thăm dò:
  • Gateway remote đã cấu hình của bạn (nếu đã đặt), và
  • localhost (loopback) ngay cả khi remote đã được cấu hình.
Nếu bạn truyền --url, mục tiêu rõ ràng đó được thêm vào trước cả hai. Đầu ra cho người dùng gắn nhãn các mục tiêu là:
  • URL (explicit)
  • Remote (configured) hoặc Remote (configured, inactive)
  • Local loopback
Nếu nhiều Gateway có thể truy cập, lệnh sẽ in tất cả. Nhiều Gateway được hỗ trợ khi bạn dùng các profile/cổng cô lập (ví dụ bot cứu hộ), nhưng hầu hết bản cài đặt vẫn chạy một Gateway duy nhất.
openclaw gateway probe
openclaw gateway probe --json
  • Reachable: yes nghĩa là ít nhất một mục tiêu đã chấp nhận kết nối WebSocket.
  • Capability: read-only|write-capable|admin-capable|pairing-pending|connect-only báo cáo điều thăm dò có thể chứng minh về xác thực. Nó tách biệt với khả năng truy cập.
  • Read probe: ok nghĩa là các lệnh gọi RPC chi tiết phạm vi đọc (health/status/system-presence/config.get) cũng thành công.
  • Read probe: limited - missing scope: operator.read nghĩa là kết nối thành công nhưng RPC phạm vi đọc bị giới hạn. Trạng thái này được báo cáo là khả năng truy cập suy giảm, không phải thất bại hoàn toàn.
  • Read probe: failed sau Connect: ok nghĩa là Gateway đã chấp nhận kết nối WebSocket, nhưng chẩn đoán đọc tiếp theo hết thời gian chờ hoặc thất bại. Đây cũng là khả năng truy cập suy giảm, không phải Gateway không truy cập được.
  • Giống gateway status, thăm dò tái sử dụng xác thực thiết bị đã lưu trong bộ nhớ đệm nhưng không tạo danh tính thiết bị lần đầu hoặc trạng thái ghép đôi.
  • Mã thoát chỉ khác 0 khi không có mục tiêu được thăm dò nào có thể truy cập.
Cấp cao nhất:
  • ok: ít nhất một mục tiêu có thể truy cập.
  • degraded: ít nhất một mục tiêu đã chấp nhận kết nối nhưng không hoàn tất đầy đủ chẩn đoán RPC chi tiết.
  • capability: khả năng tốt nhất thấy được trên các mục tiêu có thể truy cập (read_only, write_capable, admin_capable, pairing_pending, connected_no_operator_scope, hoặc unknown).
  • primaryTargetId: mục tiêu tốt nhất để coi là bên thắng đang hoạt động theo thứ tự này: URL rõ ràng, đường hầm SSH, remote đã cấu hình, rồi local loopback.
  • warnings[]: bản ghi cảnh báo nỗ lực tối đa với code, message và targetIds tùy chọn.
  • network: gợi ý URL local loopback/tailnet bắt nguồn từ cấu hình hiện tại và mạng của host.
  • discovery.timeoutMs và discovery.count: ngân sách/kết quả số lượng khám phá thực tế được dùng cho lượt thăm dò này.
Theo từng mục tiêu (targets[].connect):
  • ok: khả năng truy cập sau phân loại kết nối + suy giảm.
  • rpcOk: RPC chi tiết đầy đủ thành công.
  • scopeLimited: RPC chi tiết thất bại do thiếu phạm vi operator.
Theo từng mục tiêu (targets[].auth):
  • role: vai trò xác thực được báo cáo trong hello-ok khi có sẵn.
  • scopes: các phạm vi đã cấp được báo cáo trong hello-ok khi có sẵn.
  • capability: phân loại khả năng xác thực được hiển thị cho mục tiêu đó.
  • ssh_tunnel_failed: thiết lập đường hầm SSH thất bại; lệnh đã dự phòng sang thăm dò trực tiếp.
  • multiple_gateways: nhiều hơn một mục tiêu có thể truy cập; điều này bất thường trừ khi bạn cố ý chạy các profile cô lập, chẳng hạn như bot cứu hộ.
  • auth_secretref_unresolved: một SecretRef xác thực đã cấu hình không thể được phân giải cho mục tiêu thất bại.
  • probe_scope_limited: kết nối WebSocket thành công, nhưng thăm dò đọc bị giới hạn do thiếu operator.read.

​
Remote qua SSH (tương đương ứng dụng Mac)

Chế độ “Remote over SSH” của ứng dụng macOS dùng chuyển tiếp cổng cục bộ để Gateway remote (có thể chỉ được bind vào loopback) có thể truy cập tại ws://127.0.0.1:<port>. Tương đương CLI: 
openclaw gateway probe --ssh user@gateway-host
​
--ssh <target>
string
user@host hoặc user@host:port (cổng mặc định là 22).
​
--ssh-identity <path>
string
Tệp danh tính.
​
--ssh-auto
boolean
Chọn host Gateway đầu tiên được khám phá làm mục tiêu SSH từ endpoint khám phá đã phân giải (local. cộng với miền diện rộng đã cấu hình, nếu có). Gợi ý chỉ TXT bị bỏ qua.
Cấu hình (tùy chọn, dùng làm mặc định):
  • gateway.remote.sshTarget
  • gateway.remote.sshIdentity

​
gateway call <method>

Trình trợ giúp RPC cấp thấp. 
openclaw gateway call status
openclaw gateway call logs.tail --params '{"sinceMs": 60000}'
​
--params <json>
string
mặc định:"{}"
Chuỗi đối tượng JSON cho tham số.
​
--url <url>
string
URL WebSocket Gateway.
​
--token <token>
string
Token Gateway.
​
--password <password>
string
Mật khẩu Gateway.
​
--timeout <ms>
number
Ngân sách thời gian chờ.
​
--expect-final
boolean
Chủ yếu dành cho RPC kiểu tác nhân truyền phát các sự kiện trung gian trước payload cuối cùng.
​
--json
boolean
Đầu ra JSON để máy đọc.
--params phải là JSON hợp lệ.

​
Quản lý dịch vụ Gateway

openclaw gateway install
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
openclaw gateway uninstall

​
Cài đặt bằng wrapper

Dùng --wrapper khi dịch vụ được quản lý phải khởi động thông qua một tệp thực thi khác, ví dụ một shim trình quản lý bí mật hoặc trình trợ giúp chạy dưới tư cách người dùng khác. Wrapper nhận các đối số Gateway thông thường và chịu trách nhiệm cuối cùng exec openclaw hoặc Node với các đối số đó. 
cat > ~/.local/bin/openclaw-doppler <<'EOF'
#!/usr/bin/env bash
set -euo pipefail
exec doppler run --project my-project --config production -- openclaw "$@"
EOF
chmod +x ~/.local/bin/openclaw-doppler

openclaw gateway install --wrapper ~/.local/bin/openclaw-doppler --force
openclaw gateway restart
Bạn cũng có thể đặt wrapper thông qua môi trường. gateway install xác thực rằng đường dẫn là một tệp thực thi, ghi wrapper vào ProgramArguments của dịch vụ, và lưu OPENCLAW_WRAPPER trong môi trường dịch vụ cho các lần cài đặt lại bắt buộc, cập nhật và sửa chữa bằng doctor sau này. 
OPENCLAW_WRAPPER="$HOME/.local/bin/openclaw-doppler" openclaw gateway install --force
openclaw doctor
Để xóa một wrapper đã lưu, xóa OPENCLAW_WRAPPER trong khi cài đặt lại: 
OPENCLAW_WRAPPER= openclaw gateway install --force
openclaw gateway restart
  • gateway status: --url, --token, --password, --timeout, --no-probe, --require-rpc, --deep, --json
  • gateway install: --port, --runtime <node|bun>, --token, --wrapper <path>, --force, --json
  • gateway restart: --safe, --skip-deferral, --force, --wait <duration>, --json
  • gateway uninstall|start: --json
  • gateway stop: --disable, --json
  • Dùng gateway restart để khởi động lại một dịch vụ được quản lý. Không nối chuỗi gateway stop và gateway start để thay thế cho việc khởi động lại.
  • Trên macOS, gateway stop mặc định dùng launchctl bootout, thao tác này gỡ LaunchAgent khỏi phiên khởi động hiện tại mà không lưu trạng thái vô hiệu hóa — khả năng tự khôi phục KeepAlive vẫn hoạt động cho các sự cố sập trong tương lai và gateway start bật lại sạch sẽ mà không cần chạy thủ công launchctl enable. Truyền --disable để chặn KeepAlive và RunAtLoad một cách bền vững, để Gateway không tự khởi chạy lại cho đến lần gateway start rõ ràng tiếp theo; dùng tùy chọn này khi việc dừng thủ công cần tồn tại qua các lần khởi động lại máy hoặc khởi động lại hệ thống.
  • gateway restart --safe yêu cầu Gateway đang chạy kiểm tra trước công việc OpenClaw đang hoạt động và hoãn việc khởi động lại cho đến khi việc gửi phản hồi, các lần chạy nhúng và các lần chạy tác vụ thoát hết. Không thể kết hợp --safe với --force hoặc --wait.
  • gateway restart --wait 30s ghi đè ngân sách chờ thoát khi khởi động lại đã cấu hình cho lần khởi động lại đó. Số không kèm đơn vị là mili giây; các đơn vị như s, m và h được chấp nhận. --wait 0 chờ vô thời hạn.
  • gateway restart --safe --skip-deferral chạy quy trình khởi động lại an toàn có nhận biết OpenClaw nhưng bỏ qua cổng hoãn, để Gateway phát lệnh khởi động lại ngay cả khi có báo cáo về yếu tố chặn. Đây là lối thoát cho người vận hành khi việc hoãn do lần chạy tác vụ bị kẹt; yêu cầu --safe.
  • gateway restart --force bỏ qua bước chờ công việc đang hoạt động thoát hết và khởi động lại ngay lập tức. Dùng tùy chọn này khi người vận hành đã kiểm tra các tác vụ chặn được liệt kê và muốn Gateway hoạt động trở lại ngay.
  • Các lệnh vòng đời chấp nhận --json cho kịch bản tự động.
  • Khi xác thực bằng token yêu cầu token và gateway.auth.token được quản lý bằng SecretRef, gateway install xác thực rằng SecretRef có thể phân giải nhưng không lưu token đã phân giải vào siêu dữ liệu môi trường dịch vụ.
  • Nếu xác thực bằng token yêu cầu token và SecretRef token đã cấu hình chưa được phân giải, quá trình cài đặt sẽ đóng thất bại thay vì lưu văn bản thuần dự phòng.
  • Với xác thực bằng mật khẩu trên gateway run, ưu tiên OPENCLAW_GATEWAY_PASSWORD, --password-file hoặc gateway.auth.password dựa trên SecretRef thay vì --password nội tuyến.
  • Trong chế độ xác thực suy luận, OPENCLAW_GATEWAY_PASSWORD chỉ có trong shell không nới lỏng yêu cầu token khi cài đặt; hãy dùng cấu hình bền vững (gateway.auth.password hoặc env trong cấu hình) khi cài đặt một dịch vụ được quản lý.
  • Nếu cả gateway.auth.token và gateway.auth.password đều được cấu hình và gateway.auth.mode chưa được đặt, quá trình cài đặt sẽ bị chặn cho đến khi chế độ được đặt rõ ràng.

​
Khám phá Gateway (Bonjour)

gateway discover quét các beacon Gateway (_openclaw-gw._tcp).
  • Multicast DNS-SD: local.
  • Unicast DNS-SD (Wide-Area Bonjour): chọn một miền (ví dụ: openclaw.internal.) và thiết lập split DNS + máy chủ DNS; xem Bonjour.
Chỉ các Gateway đã bật khám phá Bonjour (mặc định) mới quảng bá beacon. Bản ghi khám phá diện rộng có thể bao gồm các gợi ý TXT này:
  • role (gợi ý vai trò Gateway)
  • transport (gợi ý phương thức truyền tải, ví dụ gateway)
  • gatewayPort (cổng WebSocket, thường là 18789)
  • sshPort (chỉ ở chế độ khám phá đầy đủ; client mặc định dùng mục tiêu SSH là 22 khi mục này vắng mặt)
  • tailnetDns (tên máy chủ MagicDNS, khi có)
  • gatewayTls / gatewayTlsSha256 (TLS đã bật + dấu vân tay chứng chỉ)
  • cliPath (chỉ ở chế độ khám phá đầy đủ)

​
gateway discover

openclaw gateway discover
​
--timeout <ms>
number
mặc định:"2000"
Thời gian chờ cho mỗi lệnh (duyệt/phân giải).
​
--json
boolean
Đầu ra máy có thể đọc được (đồng thời tắt định dạng hiển thị/vòng xoay).
Ví dụ: 
openclaw gateway discover --timeout 4000
openclaw gateway discover --json | jq '.beacons[].wsUrl'
  • CLI quét local. cùng với miền diện rộng đã cấu hình khi có miền được bật.
  • wsUrl trong đầu ra JSON được suy ra từ điểm cuối dịch vụ đã phân giải, không phải từ các gợi ý chỉ có trong TXT như lanHost hoặc tailnetDns.
  • Trên mDNS local. và DNS-SD diện rộng, sshPort và cliPath chỉ được công bố khi discovery.mdns.mode là full.

​
Liên quan