chore: sync content to repository - open-claw (#9832)

* chore: sync content to repo * Update security-risks@gN2oNDE7FXPyBh_5ZOu_Z.md * Fix formatting in HEARTBEAT.md description Removed unnecessary brackets from the HEARTBEAT.md description. * Remove markdown links from usage best practices --------- Co-authored-by: kamranahmedse <4921183+kamranahmedse@users.noreply.github.com> Co-authored-by: Javier Canales <56018501+jcanalesluna@users.noreply.github.com>
2026-04-07 18:08:49 +02:00
1 parent a8a620be98
commit 7b7413428e
@@ -0,0 +1,8 @@
+# openclaw doctor --deep
+
+`openclaw doctor --deep` is an extended version of `openclaw doctor` that performs a more thorough diagnostic check, scanning system services for extra gateway installs and deeper configuration issues that the standard check might miss. You can add the `--yes` flag to automatically accept any prompts without manual input, which is useful for running the command in a headless or
+
+Visit the following resources to learn more:
+
+- [@official@Doctor](https://docs.openclaw.ai/gateway/doctor)
+- [@official@doctor](https://docs.openclaw.ai/cli/doctor)
@@ -0,0 +1,8 @@
+# openclaw gateway
+
+`openclaw gateway` is the main command for interacting with the gateway process. It is the entry point for all gateway-related operations from the command line.
+
+Visit the following resources to learn more:
+
+- [@official@Gateway Runbook](https://docs.openclaw.ai/gateway)
+- [@official@gateway](https://docs.openclaw.ai/cli/gateway#gateway)
@@ -5,4 +5,4 @@ HEARTBEAT.md is a workspace configuration file where you define what the agent s
 Visit the following resources to learn more:

 - [@official@HEARTBEAT.md](https://docs.openclaw.ai/gateway/heartbeat#heartbeat-md-optional)
- [@official@HEARTBEAT.md Template](https://docs.openclaw.ai/reference/templates/HEARTBEAT)
+- [@official@HEARTBEAT.md Template](https://docs.openclaw.ai/reference/templates/HEARTBEAT)
@@ -0,0 +1,8 @@
+# openclaw models auth add
+
+`openclaw models auth add` is the interactive auth helper. It can launch a provider auth flow (OAuth/API key) or guide you into manual token paste, depending on the provider you choose.
+
+Visit the following resources to learn more:
+
+- [@official@Model Providers](https://docs.openclaw.ai/concepts/model-providers#model-providers)
+- [@official@Auth Providers](https://docs.openclaw.ai/cli/models#auth-profiles)
@@ -0,0 +1,7 @@
+# VPS & Cloud Providers
+
+Open Claw runs on any VPS or cloud server that supports Node.js, so you are not locked into a specific provider. The official docs include setup guides for several popular options, including DigitalOcean, Render, Hetzner, Fly.io, Google Cloud Platform, Azure, and exe.dev, each with different trade-offs around pricing, location, and ease of setup
+
+Visit the following resources to learn more:
+
+- [@official@Hosting and Deployment](https://docs.openclaw.ai/install#hosting-and-deployment)
@@ -1,4 +1,4 @@
-# Run `openclaw security audit --deep` After Every Config Change
+# Run openclaw security audit --deep After Every Config Change

 Every configuration change is an opportunity to accidentally introduce a vulnerability. Running a deep security audit after changes catches problems before they become incidents.

@@ -0,0 +1,8 @@
+# Security Best Practices
+
+Use a local machine setup only for single-user personal use. Bind the Gateway to localhost so it is never exposed to the internet, set a strong randomly generated auth token, and store all API keys in environment variables rather than config files. Run Open Claw as a non-root user, keep your sender allowlist to just yourself, and enable device pairing so unknown devices cannot connect. Run `openclaw security audit --deep` after any configuration change and keep Open Claw updated regularly.
+
+Visit the following resources to learn more:
+
+- [@official@Security](https://docs.openclaw.ai/gateway/security)
+- [@official@Gateway Runbook](https://docs.openclaw.ai/gateway)
@@ -5,4 +5,4 @@ Plugins run at a deeper level than skills and can have significant access to you
 Visit the following resources to learn more:

 - [@official@Install and Configure](https://docs.openclaw.ai/tools/plugin)
- [@official@Threat Model](https://docs.openclaw.ai/security/THREAT-MODEL-ATLAS)
+- [@official@Threat Model](https://docs.openclaw.ai/security/THREAT-MODEL-ATLAS)
@@ -0,0 +1,8 @@
+# Sessions
+
+A session is the conversation context tied to a specific agent and chat source. Direct messages share one session by default, but you can isolate each sender into their own context, strongly recommended if more than one person can message your agent. All session state is owned by the Gateway and maintained automatically through pruning and entry caps to keep the store bounded over time.
+
+Visit the following resources to learn more:
+
+- [@official@Session Management](https://docs.openclaw.ai/concepts/session)
+- [@official@Session Pruning](https://docs.openclaw.ai/concepts/session-pruning)
@@ -4,4 +4,4 @@ To get the most out of Open Claw, run `openclaw doctor` regularly to catch confi

 Visit the following resources to learn more:

- [@official@CLI Reference](https://docs.openclaw.ai/cli)
+- [@official@CLI Reference](https://docs.openclaw.ai/cli)
@@ -0,0 +1,8 @@
+# Why and Why not?
+
+A local machine is the right choice if you are just getting started, experimenting with Open Claw, or running it as a personal assistant for yourself only. It requires no ongoing costs, no remote infrastructure to manage, and lets you get up and running in minutes. It is not a good fit if you need your agent to be available 24/7, reachable from outside your home network, or capable of receiving webhooks from external services, since your agent goes offline whenever your machine is off or asleep and most home networks block incoming traffic by default.
+
+Visit the following resources to learn more:
+
+- [@official@Platforms](https://docs.openclaw.ai/platforms)
+- [@official@Getting Started](https://docs.openclaw.ai/start/getting-started)
@@ -0,0 +1,8 @@
+# Limitations
+
+Running Open Claw on a local machine means your agent is completely unreachable whenever your computer is off, asleep, or restarting. Most home internet connections also block unsolicited incoming traffic by default, which makes it difficult for external services to trigger your agent via webhooks. On top of that, your home IP address may change periodically depending on your internet provider, which can break any external connections you have configured. For anything beyond personal experimentation, a VPS or dedicated device is a more reliable choice.
+
+Visit the following resources to learn more:
+
+- [@official@Platforms](https://docs.openclaw.ai/platforms)
+- [@official@Remote Access](https://docs.openclaw.ai/gateway/remote)
@@ -0,0 +1,7 @@
+# When to Use a VPS or Cloud Server
+
+A VPS or cloud server is the right choice if you need your agent to be always online, reachable from anywhere, and capable of receiving webhooks from external services. It is the most common production setup and works well for personal assistants, team automation, and any workflow that requires continuous availability. It is not a good fit if you want to avoid recurring costs, prefer to keep everything on hardware you physically own, or want to run local models via Ollama without paying for a powerful enough remote machine.
+
+Visit the following resources to learn more:
+
+- [@official@Remote Access](https://docs.openclaw.ai/gateway/remote#macos-persistent-ssh-tunnel-via-launchagent)