nodmix 2026.5.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11573 -0
- package/LICENSE +21 -0
- package/README.md +486 -0
- package/docs/.i18n/README.md +81 -0
- package/docs/.i18n/ar-navigation.json +18 -0
- package/docs/.i18n/de-navigation.json +18 -0
- package/docs/.i18n/es-navigation.json +18 -0
- package/docs/.i18n/fr-navigation.json +18 -0
- package/docs/.i18n/glossary.ar.json +78 -0
- package/docs/.i18n/glossary.de.json +78 -0
- package/docs/.i18n/glossary.es.json +78 -0
- package/docs/.i18n/glossary.fa.json +78 -0
- package/docs/.i18n/glossary.fr.json +78 -0
- package/docs/.i18n/glossary.id.json +78 -0
- package/docs/.i18n/glossary.it.json +78 -0
- package/docs/.i18n/glossary.ja-JP.json +98 -0
- package/docs/.i18n/glossary.ko.json +78 -0
- package/docs/.i18n/glossary.nl.json +78 -0
- package/docs/.i18n/glossary.pl.json +78 -0
- package/docs/.i18n/glossary.pt-BR.json +78 -0
- package/docs/.i18n/glossary.th.json +78 -0
- package/docs/.i18n/glossary.tr.json +78 -0
- package/docs/.i18n/glossary.uk.json +78 -0
- package/docs/.i18n/glossary.vi.json +78 -0
- package/docs/.i18n/glossary.zh-CN.json +1002 -0
- package/docs/.i18n/glossary.zh-TW.json +78 -0
- package/docs/.i18n/id-navigation.json +18 -0
- package/docs/.i18n/it-navigation.json +18 -0
- package/docs/.i18n/ja-navigation.json +18 -0
- package/docs/.i18n/ko-navigation.json +18 -0
- package/docs/.i18n/pl-navigation.json +18 -0
- package/docs/.i18n/pt-BR-navigation.json +18 -0
- package/docs/.i18n/tr-navigation.json +18 -0
- package/docs/.i18n/translation-workflow.md +111 -0
- package/docs/.i18n/zh-Hans-navigation.json +542 -0
- package/docs/AGENTS.md +36 -0
- package/docs/announcements/bluebubbles-imessage.md +79 -0
- package/docs/assets/install-script.svg +1 -0
- package/docs/assets/macos-onboarding/01-macos-warning.jpeg +0 -0
- package/docs/assets/macos-onboarding/02-local-networks.jpeg +0 -0
- package/docs/assets/macos-onboarding/03-security-notice.png +0 -0
- package/docs/assets/macos-onboarding/04-choose-gateway.png +0 -0
- package/docs/assets/macos-onboarding/05-permissions.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.png +0 -0
- package/docs/assets/openclaw-logo-text-dark.svg +418 -0
- package/docs/assets/openclaw-logo-text.png +0 -0
- package/docs/assets/openclaw-logo-text.svg +418 -0
- package/docs/assets/pixel-lobster.svg +60 -0
- package/docs/assets/pr/quick-settings-browser-tools.png +0 -0
- package/docs/assets/showcase/agents-ui.jpg +0 -0
- package/docs/assets/showcase/bambu-cli.png +0 -0
- package/docs/assets/showcase/codexmonitor.png +0 -0
- package/docs/assets/showcase/gohome-grafana.png +0 -0
- package/docs/assets/showcase/ios-testflight.jpg +0 -0
- package/docs/assets/showcase/oura-health.png +0 -0
- package/docs/assets/showcase/padel-cli.svg +11 -0
- package/docs/assets/showcase/padel-screenshot.jpg +0 -0
- package/docs/assets/showcase/papla-tts.jpg +0 -0
- package/docs/assets/showcase/pr-review-telegram.jpg +0 -0
- package/docs/assets/showcase/roborock-screenshot.jpg +0 -0
- package/docs/assets/showcase/roborock-status.svg +13 -0
- package/docs/assets/showcase/roof-camera-sky.jpg +0 -0
- package/docs/assets/showcase/snag.png +0 -0
- package/docs/assets/showcase/tesco-shop.jpg +0 -0
- package/docs/assets/showcase/wienerlinien.png +0 -0
- package/docs/assets/showcase/wine-cellar-skill.jpg +0 -0
- package/docs/assets/showcase/winix-air-purifier.jpg +0 -0
- package/docs/assets/showcase/xuezh-pronunciation.jpeg +0 -0
- package/docs/assets/sponsors/blacksmith-light.svg +14 -0
- package/docs/assets/sponsors/blacksmith.svg +14 -0
- package/docs/assets/sponsors/convex-light.svg +16 -0
- package/docs/assets/sponsors/convex.svg +16 -0
- package/docs/assets/sponsors/github-light.svg +3 -0
- package/docs/assets/sponsors/github.svg +3 -0
- package/docs/assets/sponsors/nvidia-dark.svg +9 -0
- package/docs/assets/sponsors/nvidia.svg +9 -0
- package/docs/assets/sponsors/openai-light.svg +3 -0
- package/docs/assets/sponsors/openai.svg +3 -0
- package/docs/assets/sponsors/vercel-light.svg +5 -0
- package/docs/assets/sponsors/vercel.svg +5 -0
- package/docs/auth-credential-semantics.md +124 -0
- package/docs/automation/auth-monitoring.md +11 -0
- package/docs/automation/clawflow.md +12 -0
- package/docs/automation/cron-jobs.md +500 -0
- package/docs/automation/cron-vs-heartbeat.md +11 -0
- package/docs/automation/gmail-pubsub.md +11 -0
- package/docs/automation/hooks.md +365 -0
- package/docs/automation/index.md +135 -0
- package/docs/automation/poll.md +12 -0
- package/docs/automation/standing-orders.md +250 -0
- package/docs/automation/taskflow.md +155 -0
- package/docs/automation/tasks.md +374 -0
- package/docs/automation/troubleshooting.md +12 -0
- package/docs/automation/webhook.md +12 -0
- package/docs/brave-search.md +11 -0
- package/docs/channels/access-groups.md +201 -0
- package/docs/channels/ambient-room-events.md +214 -0
- package/docs/channels/bot-loop-protection.md +131 -0
- package/docs/channels/broadcast-groups.md +472 -0
- package/docs/channels/channel-routing.md +162 -0
- package/docs/channels/clickclack.md +138 -0
- package/docs/channels/discord.md +1762 -0
- package/docs/channels/feishu.md +502 -0
- package/docs/channels/googlechat.md +284 -0
- package/docs/channels/group-messages.md +95 -0
- package/docs/channels/groups.md +519 -0
- package/docs/channels/imessage-from-bluebubbles.md +259 -0
- package/docs/channels/imessage.md +813 -0
- package/docs/channels/index.md +64 -0
- package/docs/channels/irc.md +253 -0
- package/docs/channels/line.md +243 -0
- package/docs/channels/location.md +71 -0
- package/docs/channels/matrix-migration.md +370 -0
- package/docs/channels/matrix-presentation.md +77 -0
- package/docs/channels/matrix-push-rules.md +150 -0
- package/docs/channels/matrix.md +921 -0
- package/docs/channels/mattermost.md +542 -0
- package/docs/channels/msteams.md +1042 -0
- package/docs/channels/nextcloud-talk.md +176 -0
- package/docs/channels/nostr.md +253 -0
- package/docs/channels/pairing.md +214 -0
- package/docs/channels/qqbot.md +309 -0
- package/docs/channels/signal.md +400 -0
- package/docs/channels/slack.md +1564 -0
- package/docs/channels/synology-chat.md +187 -0
- package/docs/channels/telegram.md +1107 -0
- package/docs/channels/tlon.md +296 -0
- package/docs/channels/troubleshooting.md +161 -0
- package/docs/channels/twitch.md +431 -0
- package/docs/channels/wechat.md +171 -0
- package/docs/channels/whatsapp.md +739 -0
- package/docs/channels/yuanbao.md +416 -0
- package/docs/channels/zalo.md +253 -0
- package/docs/channels/zalouser.md +199 -0
- package/docs/ci.md +612 -0
- package/docs/clawhub/publishing.md +96 -0
- package/docs/cli/acp.md +370 -0
- package/docs/cli/agent.md +103 -0
- package/docs/cli/agents.md +232 -0
- package/docs/cli/approvals.md +190 -0
- package/docs/cli/backup.md +97 -0
- package/docs/cli/browser.md +307 -0
- package/docs/cli/channels.md +154 -0
- package/docs/cli/clawbot.md +25 -0
- package/docs/cli/commitments.md +90 -0
- package/docs/cli/completion.md +39 -0
- package/docs/cli/config.md +504 -0
- package/docs/cli/configure.md +77 -0
- package/docs/cli/crestodian.md +332 -0
- package/docs/cli/cron.md +281 -0
- package/docs/cli/daemon.md +67 -0
- package/docs/cli/dashboard.md +33 -0
- package/docs/cli/devices.md +204 -0
- package/docs/cli/directory.md +68 -0
- package/docs/cli/dns.md +53 -0
- package/docs/cli/docs.md +73 -0
- package/docs/cli/doctor.md +237 -0
- package/docs/cli/flows.md +52 -0
- package/docs/cli/gateway.md +567 -0
- package/docs/cli/health.md +43 -0
- package/docs/cli/hooks.md +345 -0
- package/docs/cli/index.md +396 -0
- package/docs/cli/infer.md +364 -0
- package/docs/cli/logs.md +65 -0
- package/docs/cli/mcp.md +529 -0
- package/docs/cli/memory.md +183 -0
- package/docs/cli/message.md +317 -0
- package/docs/cli/migrate.md +290 -0
- package/docs/cli/models.md +224 -0
- package/docs/cli/node.md +177 -0
- package/docs/cli/nodes.md +76 -0
- package/docs/cli/onboard.md +245 -0
- package/docs/cli/pairing.md +77 -0
- package/docs/cli/path.md +502 -0
- package/docs/cli/plugins.md +454 -0
- package/docs/cli/policy.md +418 -0
- package/docs/cli/proxy.md +89 -0
- package/docs/cli/qr.md +56 -0
- package/docs/cli/reset.md +39 -0
- package/docs/cli/sandbox.md +208 -0
- package/docs/cli/secrets.md +202 -0
- package/docs/cli/security.md +124 -0
- package/docs/cli/sessions.md +164 -0
- package/docs/cli/setup.md +59 -0
- package/docs/cli/skills.md +102 -0
- package/docs/cli/status.md +45 -0
- package/docs/cli/system.md +89 -0
- package/docs/cli/tasks.md +111 -0
- package/docs/cli/tui.md +89 -0
- package/docs/cli/uninstall.md +44 -0
- package/docs/cli/update.md +242 -0
- package/docs/cli/voicecall.md +204 -0
- package/docs/cli/webhooks.md +117 -0
- package/docs/cli/wiki.md +256 -0
- package/docs/concepts/active-memory.md +856 -0
- package/docs/concepts/agent-loop.md +185 -0
- package/docs/concepts/agent-runtimes.md +243 -0
- package/docs/concepts/agent-workspace.md +230 -0
- package/docs/concepts/agent.md +136 -0
- package/docs/concepts/architecture.md +154 -0
- package/docs/concepts/channel-docking.md +145 -0
- package/docs/concepts/commitments.md +150 -0
- package/docs/concepts/compaction.md +203 -0
- package/docs/concepts/context-engine.md +306 -0
- package/docs/concepts/context.md +199 -0
- package/docs/concepts/delegate-architecture.md +319 -0
- package/docs/concepts/dreaming.md +261 -0
- package/docs/concepts/experimental-features.md +108 -0
- package/docs/concepts/features.md +91 -0
- package/docs/concepts/mantis-slack-desktop-runbook.md +202 -0
- package/docs/concepts/mantis.md +740 -0
- package/docs/concepts/markdown-formatting.md +139 -0
- package/docs/concepts/memory-builtin.md +146 -0
- package/docs/concepts/memory-honcho.md +144 -0
- package/docs/concepts/memory-qmd.md +271 -0
- package/docs/concepts/memory-search.md +166 -0
- package/docs/concepts/memory.md +258 -0
- package/docs/concepts/message-lifecycle-refactor.md +1128 -0
- package/docs/concepts/messages.md +214 -0
- package/docs/concepts/model-failover.md +385 -0
- package/docs/concepts/model-providers.md +715 -0
- package/docs/concepts/models.md +370 -0
- package/docs/concepts/multi-agent.md +619 -0
- package/docs/concepts/oauth.md +198 -0
- package/docs/concepts/openclaw-sdk.md +323 -0
- package/docs/concepts/parallel-specialist-lanes.md +127 -0
- package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
- package/docs/concepts/presence.md +117 -0
- package/docs/concepts/progress-drafts.md +362 -0
- package/docs/concepts/qa-e2e-automation.md +820 -0
- package/docs/concepts/qa-matrix.md +139 -0
- package/docs/concepts/queue-steering.md +90 -0
- package/docs/concepts/queue.md +122 -0
- package/docs/concepts/retry.md +86 -0
- package/docs/concepts/session-pruning.md +104 -0
- package/docs/concepts/session-tool.md +190 -0
- package/docs/concepts/session.md +164 -0
- package/docs/concepts/soul.md +116 -0
- package/docs/concepts/streaming.md +251 -0
- package/docs/concepts/system-prompt.md +310 -0
- package/docs/concepts/timezone.md +47 -0
- package/docs/concepts/typebox.md +309 -0
- package/docs/concepts/typing-indicators.md +88 -0
- package/docs/concepts/usage-tracking.md +66 -0
- package/docs/date-time.md +126 -0
- package/docs/debug/node-issue.md +90 -0
- package/docs/diagnostics/flags.md +138 -0
- package/docs/docs.json +1832 -0
- package/docs/gateway/authentication.md +239 -0
- package/docs/gateway/background-process.md +147 -0
- package/docs/gateway/bonjour.md +303 -0
- package/docs/gateway/bridge-protocol.md +94 -0
- package/docs/gateway/cli-backends.md +420 -0
- package/docs/gateway/config-agents.md +1514 -0
- package/docs/gateway/config-channels.md +945 -0
- package/docs/gateway/config-tools.md +769 -0
- package/docs/gateway/configuration-examples.md +705 -0
- package/docs/gateway/configuration-reference.md +1393 -0
- package/docs/gateway/configuration.md +737 -0
- package/docs/gateway/diagnostics.md +213 -0
- package/docs/gateway/discovery.md +154 -0
- package/docs/gateway/doctor.md +574 -0
- package/docs/gateway/gateway-lock.md +37 -0
- package/docs/gateway/health.md +73 -0
- package/docs/gateway/heartbeat.md +493 -0
- package/docs/gateway/index.md +383 -0
- package/docs/gateway/local-model-services.md +205 -0
- package/docs/gateway/local-models.md +355 -0
- package/docs/gateway/logging.md +149 -0
- package/docs/gateway/multiple-gateways.md +178 -0
- package/docs/gateway/network-model.md +15 -0
- package/docs/gateway/openai-http-api.md +350 -0
- package/docs/gateway/openresponses-http-api.md +347 -0
- package/docs/gateway/openshell.md +316 -0
- package/docs/gateway/opentelemetry.md +404 -0
- package/docs/gateway/operator-scopes.md +111 -0
- package/docs/gateway/pairing.md +207 -0
- package/docs/gateway/prometheus.md +230 -0
- package/docs/gateway/protocol.md +803 -0
- package/docs/gateway/remote-gateway-readme.md +169 -0
- package/docs/gateway/remote.md +280 -0
- package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +146 -0
- package/docs/gateway/sandboxing.md +545 -0
- package/docs/gateway/secrets-plan-contract.md +114 -0
- package/docs/gateway/secrets.md +609 -0
- package/docs/gateway/security/audit-checks.md +127 -0
- package/docs/gateway/security/index.md +1326 -0
- package/docs/gateway/security/secure-file-operations.md +76 -0
- package/docs/gateway/tailscale.md +156 -0
- package/docs/gateway/tools-invoke-http-api.md +169 -0
- package/docs/gateway/troubleshooting.md +772 -0
- package/docs/gateway/trusted-proxy-auth.md +451 -0
- package/docs/help/debugging.md +344 -0
- package/docs/help/environment.md +214 -0
- package/docs/help/faq-first-run.md +867 -0
- package/docs/help/faq-models.md +553 -0
- package/docs/help/faq.md +1975 -0
- package/docs/help/gpt55-codex-agentic-parity-maintainers.md +196 -0
- package/docs/help/gpt55-codex-agentic-parity.md +230 -0
- package/docs/help/index.md +39 -0
- package/docs/help/scripts.md +56 -0
- package/docs/help/testing-live.md +580 -0
- package/docs/help/testing-updates-plugins.md +291 -0
- package/docs/help/testing.md +928 -0
- package/docs/help/troubleshooting.md +424 -0
- package/docs/images/configure-model-picker-unsearchable.png +0 -0
- package/docs/images/feishu-get-group-id.png +0 -0
- package/docs/images/groups-flow.svg +52 -0
- package/docs/images/mobile-ui-screenshot.png +0 -0
- package/docs/index.md +196 -0
- package/docs/install/ansible.md +233 -0
- package/docs/install/azure.md +315 -0
- package/docs/install/bun.md +59 -0
- package/docs/install/clawdock.md +112 -0
- package/docs/install/development-channels.md +135 -0
- package/docs/install/digitalocean.md +174 -0
- package/docs/install/docker-vm-runtime.md +154 -0
- package/docs/install/docker.md +562 -0
- package/docs/install/exe-dev.md +201 -0
- package/docs/install/fly.md +524 -0
- package/docs/install/gcp.md +418 -0
- package/docs/install/hetzner.md +285 -0
- package/docs/install/hostinger.md +98 -0
- package/docs/install/index.md +221 -0
- package/docs/install/installer.md +455 -0
- package/docs/install/kubernetes.md +196 -0
- package/docs/install/macos-vm.md +281 -0
- package/docs/install/migrating-claude.md +165 -0
- package/docs/install/migrating-hermes.md +177 -0
- package/docs/install/migrating.md +137 -0
- package/docs/install/nix.md +112 -0
- package/docs/install/node.md +142 -0
- package/docs/install/northflank.mdx +44 -0
- package/docs/install/oracle.md +218 -0
- package/docs/install/podman.md +210 -0
- package/docs/install/railway.mdx +92 -0
- package/docs/install/raspberry-pi.md +234 -0
- package/docs/install/render.mdx +167 -0
- package/docs/install/uninstall.md +131 -0
- package/docs/install/updating.md +280 -0
- package/docs/logging.md +318 -0
- package/docs/nav-tabs-underline.js +100 -0
- package/docs/network.md +72 -0
- package/docs/nodes/audio.md +215 -0
- package/docs/nodes/camera.md +166 -0
- package/docs/nodes/images.md +77 -0
- package/docs/nodes/index.md +439 -0
- package/docs/nodes/location-command.md +102 -0
- package/docs/nodes/media-understanding.md +469 -0
- package/docs/nodes/talk.md +154 -0
- package/docs/nodes/troubleshooting.md +123 -0
- package/docs/nodes/voicewake.md +93 -0
- package/docs/perplexity.md +11 -0
- package/docs/pi-dev.md +82 -0
- package/docs/pi.md +573 -0
- package/docs/plan/codex-context-engine-harness.md +624 -0
- package/docs/plan/ui-channels.md +284 -0
- package/docs/platforms/android.md +285 -0
- package/docs/platforms/digitalocean.md +12 -0
- package/docs/platforms/index.md +60 -0
- package/docs/platforms/ios.md +283 -0
- package/docs/platforms/linux.md +141 -0
- package/docs/platforms/mac/bundled-gateway.md +79 -0
- package/docs/platforms/mac/canvas.md +128 -0
- package/docs/platforms/mac/child-process.md +72 -0
- package/docs/platforms/mac/dev-setup.md +112 -0
- package/docs/platforms/mac/health.md +39 -0
- package/docs/platforms/mac/icon.md +36 -0
- package/docs/platforms/mac/logging.md +62 -0
- package/docs/platforms/mac/menu-bar.md +93 -0
- package/docs/platforms/mac/peekaboo.md +92 -0
- package/docs/platforms/mac/permissions.md +53 -0
- package/docs/platforms/mac/remote.md +123 -0
- package/docs/platforms/mac/signing.md +52 -0
- package/docs/platforms/mac/skills.md +43 -0
- package/docs/platforms/mac/voice-overlay.md +66 -0
- package/docs/platforms/mac/voicewake.md +73 -0
- package/docs/platforms/mac/webchat.md +54 -0
- package/docs/platforms/mac/xpc.md +66 -0
- package/docs/platforms/macos.md +226 -0
- package/docs/platforms/oracle.md +12 -0
- package/docs/platforms/raspberry-pi.md +13 -0
- package/docs/platforms/windows.md +286 -0
- package/docs/plugins/adding-capabilities.md +133 -0
- package/docs/plugins/admin-http-rpc.md +216 -0
- package/docs/plugins/agent-tools.md +13 -0
- package/docs/plugins/architecture-internals.md +1195 -0
- package/docs/plugins/architecture.md +481 -0
- package/docs/plugins/building-extensions.md +13 -0
- package/docs/plugins/building-plugins.md +330 -0
- package/docs/plugins/bundles.md +310 -0
- package/docs/plugins/cli-backend-plugins.md +310 -0
- package/docs/plugins/codex-computer-use.md +293 -0
- package/docs/plugins/codex-harness-reference.md +409 -0
- package/docs/plugins/codex-harness-runtime.md +247 -0
- package/docs/plugins/codex-harness.md +746 -0
- package/docs/plugins/codex-native-plugins.md +276 -0
- package/docs/plugins/community.md +77 -0
- package/docs/plugins/compatibility.md +164 -0
- package/docs/plugins/dependency-resolution.md +143 -0
- package/docs/plugins/google-meet.md +1737 -0
- package/docs/plugins/hooks.md +459 -0
- package/docs/plugins/install-overrides.md +80 -0
- package/docs/plugins/manage-plugins.md +210 -0
- package/docs/plugins/manifest.md +1359 -0
- package/docs/plugins/memory-lancedb.md +385 -0
- package/docs/plugins/memory-wiki.md +529 -0
- package/docs/plugins/message-presentation.md +473 -0
- package/docs/plugins/oc-path.md +166 -0
- package/docs/plugins/plugin-inventory.md +182 -0
- package/docs/plugins/reference/acpx.md +23 -0
- package/docs/plugins/reference/admin-http-rpc.md +23 -0
- package/docs/plugins/reference/alibaba.md +23 -0
- package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
- package/docs/plugins/reference/amazon-bedrock.md +23 -0
- package/docs/plugins/reference/anthropic-vertex.md +19 -0
- package/docs/plugins/reference/anthropic.md +23 -0
- package/docs/plugins/reference/arcee.md +23 -0
- package/docs/plugins/reference/azure-speech.md +23 -0
- package/docs/plugins/reference/bonjour.md +19 -0
- package/docs/plugins/reference/brave.md +23 -0
- package/docs/plugins/reference/browser.md +23 -0
- package/docs/plugins/reference/byteplus.md +19 -0
- package/docs/plugins/reference/canvas.md +19 -0
- package/docs/plugins/reference/cerebras.md +23 -0
- package/docs/plugins/reference/chutes.md +23 -0
- package/docs/plugins/reference/clickclack.md +23 -0
- package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
- package/docs/plugins/reference/codex.md +23 -0
- package/docs/plugins/reference/comfy.md +23 -0
- package/docs/plugins/reference/copilot-proxy.md +19 -0
- package/docs/plugins/reference/deepgram.md +23 -0
- package/docs/plugins/reference/deepinfra.md +23 -0
- package/docs/plugins/reference/deepseek.md +23 -0
- package/docs/plugins/reference/diagnostics-otel.md +19 -0
- package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
- package/docs/plugins/reference/diffs.md +19 -0
- package/docs/plugins/reference/discord.md +23 -0
- package/docs/plugins/reference/document-extract.md +23 -0
- package/docs/plugins/reference/duckduckgo.md +23 -0
- package/docs/plugins/reference/elevenlabs.md +23 -0
- package/docs/plugins/reference/exa.md +23 -0
- package/docs/plugins/reference/fal.md +23 -0
- package/docs/plugins/reference/feishu.md +23 -0
- package/docs/plugins/reference/file-transfer.md +19 -0
- package/docs/plugins/reference/firecrawl.md +23 -0
- package/docs/plugins/reference/fireworks.md +23 -0
- package/docs/plugins/reference/github-copilot.md +23 -0
- package/docs/plugins/reference/google-meet.md +23 -0
- package/docs/plugins/reference/google.md +23 -0
- package/docs/plugins/reference/googlechat.md +23 -0
- package/docs/plugins/reference/gradium.md +23 -0
- package/docs/plugins/reference/groq.md +23 -0
- package/docs/plugins/reference/huggingface.md +23 -0
- package/docs/plugins/reference/imessage.md +23 -0
- package/docs/plugins/reference/inworld.md +23 -0
- package/docs/plugins/reference/irc.md +23 -0
- package/docs/plugins/reference/kilocode.md +23 -0
- package/docs/plugins/reference/kimi.md +23 -0
- package/docs/plugins/reference/line.md +23 -0
- package/docs/plugins/reference/litellm.md +23 -0
- package/docs/plugins/reference/llm-task.md +19 -0
- package/docs/plugins/reference/lmstudio.md +23 -0
- package/docs/plugins/reference/lobster.md +19 -0
- package/docs/plugins/reference/matrix.md +23 -0
- package/docs/plugins/reference/mattermost.md +23 -0
- package/docs/plugins/reference/memory-core.md +19 -0
- package/docs/plugins/reference/memory-lancedb.md +23 -0
- package/docs/plugins/reference/memory-wiki.md +23 -0
- package/docs/plugins/reference/microsoft-foundry.md +19 -0
- package/docs/plugins/reference/microsoft.md +19 -0
- package/docs/plugins/reference/migrate-claude.md +19 -0
- package/docs/plugins/reference/migrate-hermes.md +19 -0
- package/docs/plugins/reference/minimax.md +23 -0
- package/docs/plugins/reference/mistral.md +23 -0
- package/docs/plugins/reference/moonshot.md +23 -0
- package/docs/plugins/reference/msteams.md +23 -0
- package/docs/plugins/reference/nextcloud-talk.md +23 -0
- package/docs/plugins/reference/nostr.md +23 -0
- package/docs/plugins/reference/nvidia.md +23 -0
- package/docs/plugins/reference/oc-path.md +23 -0
- package/docs/plugins/reference/ollama.md +23 -0
- package/docs/plugins/reference/open-prose.md +19 -0
- package/docs/plugins/reference/openai.md +23 -0
- package/docs/plugins/reference/opencode-go.md +23 -0
- package/docs/plugins/reference/opencode.md +23 -0
- package/docs/plugins/reference/openrouter.md +23 -0
- package/docs/plugins/reference/openshell.md +19 -0
- package/docs/plugins/reference/perplexity.md +23 -0
- package/docs/plugins/reference/policy.md +23 -0
- package/docs/plugins/reference/qa-channel.md +23 -0
- package/docs/plugins/reference/qa-lab.md +19 -0
- package/docs/plugins/reference/qa-matrix.md +19 -0
- package/docs/plugins/reference/qianfan.md +23 -0
- package/docs/plugins/reference/qqbot.md +23 -0
- package/docs/plugins/reference/qwen.md +23 -0
- package/docs/plugins/reference/runway.md +23 -0
- package/docs/plugins/reference/searxng.md +19 -0
- package/docs/plugins/reference/senseaudio.md +23 -0
- package/docs/plugins/reference/sglang.md +23 -0
- package/docs/plugins/reference/signal.md +23 -0
- package/docs/plugins/reference/skill-workshop.md +23 -0
- package/docs/plugins/reference/slack.md +23 -0
- package/docs/plugins/reference/stepfun.md +23 -0
- package/docs/plugins/reference/synology-chat.md +23 -0
- package/docs/plugins/reference/synthetic.md +23 -0
- package/docs/plugins/reference/tavily.md +23 -0
- package/docs/plugins/reference/telegram.md +23 -0
- package/docs/plugins/reference/tencent.md +23 -0
- package/docs/plugins/reference/tlon.md +23 -0
- package/docs/plugins/reference/together.md +23 -0
- package/docs/plugins/reference/tokenjuice.md +23 -0
- package/docs/plugins/reference/tts-local-cli.md +19 -0
- package/docs/plugins/reference/twitch.md +23 -0
- package/docs/plugins/reference/venice.md +23 -0
- package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
- package/docs/plugins/reference/vllm.md +23 -0
- package/docs/plugins/reference/voice-call.md +23 -0
- package/docs/plugins/reference/volcengine.md +23 -0
- package/docs/plugins/reference/voyage.md +19 -0
- package/docs/plugins/reference/vydra.md +23 -0
- package/docs/plugins/reference/web-readability.md +19 -0
- package/docs/plugins/reference/webhooks.md +23 -0
- package/docs/plugins/reference/whatsapp.md +23 -0
- package/docs/plugins/reference/xai.md +23 -0
- package/docs/plugins/reference/xiaomi.md +23 -0
- package/docs/plugins/reference/zai.md +23 -0
- package/docs/plugins/reference/zalo.md +23 -0
- package/docs/plugins/reference/zalouser.md +24 -0
- package/docs/plugins/reference.md +138 -0
- package/docs/plugins/sdk-agent-harness.md +339 -0
- package/docs/plugins/sdk-channel-ingress.md +137 -0
- package/docs/plugins/sdk-channel-message.md +458 -0
- package/docs/plugins/sdk-channel-plugins.md +762 -0
- package/docs/plugins/sdk-channel-turn.md +580 -0
- package/docs/plugins/sdk-entrypoints.md +333 -0
- package/docs/plugins/sdk-migration.md +949 -0
- package/docs/plugins/sdk-overview.md +501 -0
- package/docs/plugins/sdk-provider-plugins.md +807 -0
- package/docs/plugins/sdk-runtime.md +676 -0
- package/docs/plugins/sdk-setup.md +550 -0
- package/docs/plugins/sdk-subpaths.md +396 -0
- package/docs/plugins/sdk-testing.md +401 -0
- package/docs/plugins/skill-workshop.md +713 -0
- package/docs/plugins/tool-plugins.md +411 -0
- package/docs/plugins/voice-call.md +943 -0
- package/docs/plugins/webhooks.md +192 -0
- package/docs/plugins/zalouser.md +86 -0
- package/docs/prose.md +137 -0
- package/docs/providers/alibaba.md +158 -0
- package/docs/providers/anthropic.md +344 -0
- package/docs/providers/arcee.md +144 -0
- package/docs/providers/azure-speech.md +119 -0
- package/docs/providers/bedrock-mantle.md +211 -0
- package/docs/providers/bedrock.md +414 -0
- package/docs/providers/cerebras.md +130 -0
- package/docs/providers/chutes.md +153 -0
- package/docs/providers/claude-max-api-proxy.md +188 -0
- package/docs/providers/cloudflare-ai-gateway.md +119 -0
- package/docs/providers/comfy.md +362 -0
- package/docs/providers/deepgram.md +184 -0
- package/docs/providers/deepinfra.md +87 -0
- package/docs/providers/deepseek.md +146 -0
- package/docs/providers/ds4.md +309 -0
- package/docs/providers/elevenlabs.md +130 -0
- package/docs/providers/fal.md +204 -0
- package/docs/providers/fireworks.md +144 -0
- package/docs/providers/github-copilot.md +225 -0
- package/docs/providers/glm.md +137 -0
- package/docs/providers/google.md +472 -0
- package/docs/providers/gradium.md +123 -0
- package/docs/providers/groq.md +180 -0
- package/docs/providers/huggingface.md +235 -0
- package/docs/providers/index.md +102 -0
- package/docs/providers/inferrs.md +272 -0
- package/docs/providers/inworld.md +120 -0
- package/docs/providers/kilocode.md +135 -0
- package/docs/providers/litellm.md +234 -0
- package/docs/providers/lmstudio.md +224 -0
- package/docs/providers/minimax.md +505 -0
- package/docs/providers/mistral.md +235 -0
- package/docs/providers/models.md +65 -0
- package/docs/providers/moonshot.md +413 -0
- package/docs/providers/nvidia.md +140 -0
- package/docs/providers/ollama.md +1180 -0
- package/docs/providers/openai.md +1057 -0
- package/docs/providers/opencode-go.md +123 -0
- package/docs/providers/opencode.md +149 -0
- package/docs/providers/openrouter.md +349 -0
- package/docs/providers/perplexity-provider.md +123 -0
- package/docs/providers/qianfan.md +132 -0
- package/docs/providers/qwen.md +332 -0
- package/docs/providers/runway.md +103 -0
- package/docs/providers/senseaudio.md +68 -0
- package/docs/providers/sglang.md +161 -0
- package/docs/providers/stepfun.md +229 -0
- package/docs/providers/synthetic.md +154 -0
- package/docs/providers/tencent.md +130 -0
- package/docs/providers/together.md +141 -0
- package/docs/providers/venice.md +315 -0
- package/docs/providers/vercel-ai-gateway.md +128 -0
- package/docs/providers/vllm.md +383 -0
- package/docs/providers/volcengine.md +199 -0
- package/docs/providers/vydra.md +180 -0
- package/docs/providers/xai.md +560 -0
- package/docs/providers/xiaomi.md +188 -0
- package/docs/providers/zai.md +203 -0
- package/docs/refactor/access.md +9 -0
- package/docs/refactor/acp.md +298 -0
- package/docs/refactor/canvas.md +131 -0
- package/docs/refactor/ingress-core.md +341 -0
- package/docs/reference/AGENTS.default.md +129 -0
- package/docs/reference/RELEASING.md +767 -0
- package/docs/reference/api-usage-costs.md +202 -0
- package/docs/reference/application-modernization-plan.md +208 -0
- package/docs/reference/code-mode.md +757 -0
- package/docs/reference/credits.md +33 -0
- package/docs/reference/device-models.md +50 -0
- package/docs/reference/full-release-validation.md +202 -0
- package/docs/reference/memory-config.md +630 -0
- package/docs/reference/openclaw-sdk-api-design.md +390 -0
- package/docs/reference/prompt-caching.md +358 -0
- package/docs/reference/rich-output-protocol.md +79 -0
- package/docs/reference/rpc.md +43 -0
- package/docs/reference/secretref-credential-surface.md +159 -0
- package/docs/reference/secretref-user-supplied-credentials-matrix.json +663 -0
- package/docs/reference/session-management-compaction.md +461 -0
- package/docs/reference/templates/AGENTS.dev.md +89 -0
- package/docs/reference/templates/AGENTS.md +225 -0
- package/docs/reference/templates/BOOT.md +16 -0
- package/docs/reference/templates/BOOTSTRAP.md +66 -0
- package/docs/reference/templates/HEARTBEAT.md +16 -0
- package/docs/reference/templates/IDENTITY.dev.md +52 -0
- package/docs/reference/templates/IDENTITY.md +34 -0
- package/docs/reference/templates/SOUL.dev.md +82 -0
- package/docs/reference/templates/SOUL.md +49 -0
- package/docs/reference/templates/TOOLS.dev.md +29 -0
- package/docs/reference/templates/TOOLS.md +51 -0
- package/docs/reference/templates/USER.dev.md +23 -0
- package/docs/reference/templates/USER.md +28 -0
- package/docs/reference/test.md +239 -0
- package/docs/reference/token-use.md +233 -0
- package/docs/reference/transcript-hygiene.md +214 -0
- package/docs/reference/wizard.md +252 -0
- package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
- package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
- package/docs/security/formal-verification.md +170 -0
- package/docs/security/incident-response.md +59 -0
- package/docs/security/network-proxy.md +268 -0
- package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
- package/docs/snippets/plugin-publish/minimal-package.json +16 -0
- package/docs/start/bootstrapping.md +49 -0
- package/docs/start/docs-directory.md +69 -0
- package/docs/start/getting-started.md +152 -0
- package/docs/start/hubs.md +201 -0
- package/docs/start/lore.md +223 -0
- package/docs/start/onboarding-overview.md +72 -0
- package/docs/start/onboarding.md +95 -0
- package/docs/start/openclaw.md +244 -0
- package/docs/start/quickstart.md +25 -0
- package/docs/start/setup.md +178 -0
- package/docs/start/showcase.md +383 -0
- package/docs/start/wizard-cli-automation.md +232 -0
- package/docs/start/wizard-cli-reference.md +331 -0
- package/docs/start/wizard.md +141 -0
- package/docs/style.css +184 -0
- package/docs/superpowers/specs/2026-04-22-tweakcn-custom-theme-import-design.md +316 -0
- package/docs/tools/acp-agents-setup.md +352 -0
- package/docs/tools/acp-agents.md +847 -0
- package/docs/tools/agent-send.md +112 -0
- package/docs/tools/apply-patch.md +64 -0
- package/docs/tools/brave-search.md +139 -0
- package/docs/tools/browser-control.md +391 -0
- package/docs/tools/browser-linux-troubleshooting.md +173 -0
- package/docs/tools/browser-login.md +77 -0
- package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
- package/docs/tools/browser.md +769 -0
- package/docs/tools/btw.md +159 -0
- package/docs/tools/capability-cookbook.md +12 -0
- package/docs/tools/clawhub.md +5 -0
- package/docs/tools/code-execution.md +173 -0
- package/docs/tools/creating-skills.md +120 -0
- package/docs/tools/diffs.md +506 -0
- package/docs/tools/duckduckgo-search.md +109 -0
- package/docs/tools/elevated.md +128 -0
- package/docs/tools/exa-search.md +152 -0
- package/docs/tools/exec-approvals-advanced.md +360 -0
- package/docs/tools/exec-approvals.md +474 -0
- package/docs/tools/exec.md +282 -0
- package/docs/tools/firecrawl.md +155 -0
- package/docs/tools/gemini-search.md +114 -0
- package/docs/tools/grok-search.md +113 -0
- package/docs/tools/image-generation.md +433 -0
- package/docs/tools/index.md +178 -0
- package/docs/tools/kimi-search.md +105 -0
- package/docs/tools/llm-task.md +137 -0
- package/docs/tools/lobster.md +365 -0
- package/docs/tools/loop-detection.md +154 -0
- package/docs/tools/media-overview.md +157 -0
- package/docs/tools/minimax-search.md +102 -0
- package/docs/tools/multi-agent-sandbox-tools.md +409 -0
- package/docs/tools/music-generation.md +371 -0
- package/docs/tools/ollama-search.md +153 -0
- package/docs/tools/pdf.md +195 -0
- package/docs/tools/perplexity-search.md +220 -0
- package/docs/tools/plugin.md +327 -0
- package/docs/tools/reactions.md +100 -0
- package/docs/tools/searxng-search.md +141 -0
- package/docs/tools/skills-config.md +195 -0
- package/docs/tools/skills.md +535 -0
- package/docs/tools/slash-commands.md +488 -0
- package/docs/tools/steer.md +84 -0
- package/docs/tools/subagents.md +650 -0
- package/docs/tools/tavily.md +162 -0
- package/docs/tools/thinking.md +140 -0
- package/docs/tools/tokenjuice.md +81 -0
- package/docs/tools/tool-search.md +269 -0
- package/docs/tools/trajectory.md +229 -0
- package/docs/tools/tts.md +1004 -0
- package/docs/tools/video-generation.md +552 -0
- package/docs/tools/web-fetch.md +195 -0
- package/docs/tools/web.md +459 -0
- package/docs/tts.md +11 -0
- package/docs/vps.md +139 -0
- package/docs/web/control-ui.md +503 -0
- package/docs/web/dashboard.md +107 -0
- package/docs/web/index.md +133 -0
- package/docs/web/tui.md +246 -0
- package/docs/web/webchat.md +99 -0
- package/docs/whatsapp-openclaw-ai-zh.jpg +0 -0
- package/docs/whatsapp-openclaw.jpg +0 -0
- package/nodmix.mjs +487 -0
- package/package.json +1852 -0
- package/patches/.gitkeep +0 -0
- package/patches/@agentclientprotocol__claude-agent-acp@0.36.1.patch +41 -0
- package/pnpm-workspace.yaml +63 -0
- package/scripts/crabbox-wrapper.mjs +353 -0
- package/scripts/lib/official-external-channel-catalog.json +559 -0
- package/scripts/lib/official-external-plugin-catalog.json +192 -0
- package/scripts/lib/official-external-provider-catalog.json +117 -0
- package/scripts/lib/package-dist-imports.mjs +171 -0
- package/scripts/npm-runner.mjs +91 -0
- package/scripts/postinstall-bundled-plugins.mjs +978 -0
- package/scripts/preinstall-package-manager-warning.mjs +64 -0
- package/scripts/windows-cmd-helpers.mjs +20 -0
- package/skills/1password/SKILL.md +70 -0
- package/skills/1password/references/cli-examples.md +29 -0
- package/skills/1password/references/get-started.md +17 -0
- package/skills/apple-notes/SKILL.md +77 -0
- package/skills/apple-reminders/SKILL.md +118 -0
- package/skills/bear-notes/SKILL.md +107 -0
- package/skills/blogwatcher/SKILL.md +69 -0
- package/skills/blucli/SKILL.md +47 -0
- package/skills/camsnap/SKILL.md +45 -0
- package/skills/canvas/SKILL.md +78 -0
- package/skills/clawhub/SKILL.md +77 -0
- package/skills/coding-agent/SKILL.md +149 -0
- package/skills/diagram-maker/SKILL.md +53 -0
- package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
- package/skills/diagram-maker/references/svg-template.md +112 -0
- package/skills/discord/SKILL.md +136 -0
- package/skills/eightctl/SKILL.md +50 -0
- package/skills/gemini/SKILL.md +47 -0
- package/skills/gh-issues/SKILL.md +213 -0
- package/skills/gifgrep/SKILL.md +85 -0
- package/skills/github/SKILL.md +84 -0
- package/skills/gog/SKILL.md +116 -0
- package/skills/goplaces/SKILL.md +52 -0
- package/skills/healthcheck/SKILL.md +105 -0
- package/skills/himalaya/SKILL.md +80 -0
- package/skills/himalaya/references/configuration.md +184 -0
- package/skills/himalaya/references/message-composition.md +199 -0
- package/skills/imsg/SKILL.md +122 -0
- package/skills/mcporter/SKILL.md +61 -0
- package/skills/meme-maker/SKILL.md +42 -0
- package/skills/meme-maker/references/templates.json +358 -0
- package/skills/meme-maker/scripts/meme.mjs +398 -0
- package/skills/model-usage/SKILL.md +69 -0
- package/skills/model-usage/references/codexbar-cli.md +33 -0
- package/skills/model-usage/scripts/model_usage.py +319 -0
- package/skills/model-usage/scripts/test_model_usage.py +40 -0
- package/skills/nano-pdf/SKILL.md +38 -0
- package/skills/node-connect/SKILL.md +142 -0
- package/skills/node-inspect-debugger/SKILL.md +85 -0
- package/skills/notion/SKILL.md +150 -0
- package/skills/obsidian/SKILL.md +119 -0
- package/skills/openai-whisper/SKILL.md +38 -0
- package/skills/openai-whisper-api/SKILL.md +71 -0
- package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
- package/skills/openhue/SKILL.md +112 -0
- package/skills/oracle/SKILL.md +126 -0
- package/skills/ordercli/SKILL.md +78 -0
- package/skills/peekaboo/SKILL.md +190 -0
- package/skills/pyproject.toml +10 -0
- package/skills/python-debugpy/SKILL.md +73 -0
- package/skills/sag/SKILL.md +87 -0
- package/skills/session-logs/SKILL.md +151 -0
- package/skills/sherpa-onnx-tts/SKILL.md +109 -0
- package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
- package/skills/skill-creator/SKILL.md +78 -0
- package/skills/skill-creator/license.txt +202 -0
- package/skills/skill-creator/scripts/init_skill.py +378 -0
- package/skills/skill-creator/scripts/package_skill.py +139 -0
- package/skills/skill-creator/scripts/quick_validate.py +169 -0
- package/skills/skill-creator/scripts/test_package_skill.py +161 -0
- package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
- package/skills/slack/SKILL.md +78 -0
- package/skills/songsee/SKILL.md +49 -0
- package/skills/sonoscli/SKILL.md +65 -0
- package/skills/spike/SKILL.md +51 -0
- package/skills/spotify-player/SKILL.md +64 -0
- package/skills/summarize/SKILL.md +87 -0
- package/skills/taskflow/SKILL.md +149 -0
- package/skills/taskflow/examples/inbox-triage.lobster +33 -0
- package/skills/taskflow/examples/pr-intake.lobster +32 -0
- package/skills/taskflow-inbox-triage/SKILL.md +119 -0
- package/skills/things-mac/SKILL.md +86 -0
- package/skills/tmux/SKILL.md +91 -0
- package/skills/tmux/scripts/find-sessions.sh +112 -0
- package/skills/tmux/scripts/wait-for-text.sh +83 -0
- package/skills/trello/SKILL.md +108 -0
- package/skills/video-frames/SKILL.md +46 -0
- package/skills/video-frames/scripts/frame.sh +81 -0
- package/skills/voice-call/SKILL.md +45 -0
- package/skills/wacli/SKILL.md +72 -0
- package/skills/weather/SKILL.md +64 -0
- package/skills/xurl/SKILL.md +120 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "SSH tunnel setup for Nodmix.app connecting to a remote gateway"
|
|
3
|
+
read_when: "Connecting the macOS app to a remote gateway over SSH"
|
|
4
|
+
title: "Remote gateway setup"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
> This content has been merged into [Remote Access](/gateway/remote#macos-persistent-ssh-tunnel-via-launchagent). See that page for the current guide.
|
|
8
|
+
|
|
9
|
+
# Running Nodmix.app with a Remote Gateway
|
|
10
|
+
|
|
11
|
+
Nodmix.app uses SSH tunneling to connect to a remote gateway. This guide shows you how to set it up.
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
```mermaid
|
|
16
|
+
flowchart TB
|
|
17
|
+
subgraph Client["Client Machine"]
|
|
18
|
+
direction TB
|
|
19
|
+
A["Nodmix.app"]
|
|
20
|
+
B["ws://127.0.0.1:18789\n(local port)"]
|
|
21
|
+
T["SSH Tunnel"]
|
|
22
|
+
|
|
23
|
+
A --> B
|
|
24
|
+
B --> T
|
|
25
|
+
end
|
|
26
|
+
subgraph Remote["Remote Machine"]
|
|
27
|
+
direction TB
|
|
28
|
+
C["Gateway WebSocket"]
|
|
29
|
+
D["ws://127.0.0.1:18789"]
|
|
30
|
+
|
|
31
|
+
C --> D
|
|
32
|
+
end
|
|
33
|
+
T --> C
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Quick setup
|
|
37
|
+
|
|
38
|
+
### Step 1: Add SSH Config
|
|
39
|
+
|
|
40
|
+
Edit `~/.ssh/config` and add:
|
|
41
|
+
|
|
42
|
+
```ssh
|
|
43
|
+
Host remote-gateway
|
|
44
|
+
HostName <REMOTE_IP> # e.g., 172.27.187.184
|
|
45
|
+
User <REMOTE_USER> # e.g., jefferson
|
|
46
|
+
LocalForward 18789 127.0.0.1:18789
|
|
47
|
+
IdentityFile ~/.ssh/id_rsa
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Replace `<REMOTE_IP>` and `<REMOTE_USER>` with your values.
|
|
51
|
+
|
|
52
|
+
### Step 2: Copy SSH Key
|
|
53
|
+
|
|
54
|
+
Copy your public key to the remote machine (enter password once):
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
ssh-copy-id -i ~/.ssh/id_rsa <REMOTE_USER>@<REMOTE_IP>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Step 3: Configure Remote Gateway Auth
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
nodmix config set gateway.remote.token "<your-token>"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Use `gateway.remote.password` instead if your remote gateway uses password auth.
|
|
67
|
+
`NODMIX_GATEWAY_TOKEN` is still valid as a shell-level override, but the durable
|
|
68
|
+
remote-client setup is `gateway.remote.token` / `gateway.remote.password`.
|
|
69
|
+
|
|
70
|
+
### Step 4: Start SSH Tunnel
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
ssh -N remote-gateway &
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Step 5: Restart Nodmix.app
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Quit Nodmix.app (⌘Q), then reopen:
|
|
80
|
+
open /path/to/Nodmix.app
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
The app will now connect to the remote gateway through the SSH tunnel.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Auto-Start Tunnel on Login
|
|
88
|
+
|
|
89
|
+
To have the SSH tunnel start automatically when you log in, create a Launch Agent.
|
|
90
|
+
|
|
91
|
+
### Create the PLIST file
|
|
92
|
+
|
|
93
|
+
Save this as `~/Library/LaunchAgents/ai.nodmix.ssh-tunnel.plist`:
|
|
94
|
+
|
|
95
|
+
```xml
|
|
96
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
97
|
+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
98
|
+
<plist version="1.0">
|
|
99
|
+
<dict>
|
|
100
|
+
<key>Label</key>
|
|
101
|
+
<string>ai.nodmix.ssh-tunnel</string>
|
|
102
|
+
<key>ProgramArguments</key>
|
|
103
|
+
<array>
|
|
104
|
+
<string>/usr/bin/ssh</string>
|
|
105
|
+
<string>-N</string>
|
|
106
|
+
<string>remote-gateway</string>
|
|
107
|
+
</array>
|
|
108
|
+
<key>KeepAlive</key>
|
|
109
|
+
<true/>
|
|
110
|
+
<key>RunAtLoad</key>
|
|
111
|
+
<true/>
|
|
112
|
+
</dict>
|
|
113
|
+
</plist>
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Load the Launch Agent
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
launchctl bootstrap gui/$UID ~/Library/LaunchAgents/ai.nodmix.ssh-tunnel.plist
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
The tunnel will now:
|
|
123
|
+
|
|
124
|
+
- Start automatically when you log in
|
|
125
|
+
- Restart if it crashes
|
|
126
|
+
- Keep running in the background
|
|
127
|
+
|
|
128
|
+
Legacy note: remove any leftover `com.nodmix.ssh-tunnel` LaunchAgent if present.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Troubleshooting
|
|
133
|
+
|
|
134
|
+
**Check if tunnel is running:**
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
ps aux | grep "ssh -N remote-gateway" | grep -v grep
|
|
138
|
+
lsof -i :18789
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
**Restart the tunnel:**
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
launchctl kickstart -k gui/$UID/ai.nodmix.ssh-tunnel
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
**Stop the tunnel:**
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
launchctl bootout gui/$UID/ai.nodmix.ssh-tunnel
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## How it works
|
|
156
|
+
|
|
157
|
+
| Component | What It Does |
|
|
158
|
+
| ------------------------------------ | ------------------------------------------------------------ |
|
|
159
|
+
| `LocalForward 18789 127.0.0.1:18789` | Forwards local port 18789 to remote port 18789 |
|
|
160
|
+
| `ssh -N` | SSH without executing remote commands (just port forwarding) |
|
|
161
|
+
| `KeepAlive` | Automatically restarts tunnel if it crashes |
|
|
162
|
+
| `RunAtLoad` | Starts tunnel when the agent loads |
|
|
163
|
+
|
|
164
|
+
Nodmix.app connects to `ws://127.0.0.1:18789` on your client machine. The SSH tunnel forwards that connection to port 18789 on the remote machine where the Gateway is running.
|
|
165
|
+
|
|
166
|
+
## Related
|
|
167
|
+
|
|
168
|
+
- [Remote access](/gateway/remote)
|
|
169
|
+
- [Tailscale](/gateway/tailscale)
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Remote access using Gateway WS, SSH tunnels, and tailnets"
|
|
3
|
+
read_when:
|
|
4
|
+
- Running or troubleshooting remote gateway setups
|
|
5
|
+
title: "Remote access"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
This repo supports remote gateway access by keeping a single Gateway (the master) running on a dedicated host (desktop/server) and connecting clients to it.
|
|
9
|
+
|
|
10
|
+
- For **operators (you / the macOS app)**: direct LAN/Tailnet WebSocket is simplest when the gateway is reachable; SSH tunneling is the universal fallback.
|
|
11
|
+
- For **nodes (iOS/Android and future devices)**: connect to the Gateway **WebSocket** (LAN/tailnet or SSH tunnel as needed).
|
|
12
|
+
|
|
13
|
+
## The core idea
|
|
14
|
+
|
|
15
|
+
- The Gateway WebSocket usually binds to **loopback** on your configured port (defaults to 18789).
|
|
16
|
+
- For remote use, expose it through Tailscale Serve or a trusted LAN/Tailnet bind, or forward the loopback port over SSH.
|
|
17
|
+
|
|
18
|
+
## Common VPN and tailnet setups
|
|
19
|
+
|
|
20
|
+
Think of the **Gateway host** as where the agent lives. It owns sessions, auth profiles, channels, and state. Your laptop, desktop, and nodes connect to that host.
|
|
21
|
+
|
|
22
|
+
### Always-on Gateway in your tailnet
|
|
23
|
+
|
|
24
|
+
Run the Gateway on a persistent host (VPS or home server) and reach it via **Tailscale** or SSH.
|
|
25
|
+
|
|
26
|
+
- **Best UX:** keep `gateway.bind: "loopback"` and use **Tailscale Serve** for the Control UI.
|
|
27
|
+
- **Trusted LAN/Tailnet:** bind the gateway to a private interface and connect directly with `gateway.remote.transport: "direct"`.
|
|
28
|
+
- **Fallback:** keep loopback plus SSH tunnel from any machine that needs access.
|
|
29
|
+
- **Examples:** [exe.dev](/install/exe-dev) (easy VM) or [Hetzner](/install/hetzner) (production VPS).
|
|
30
|
+
|
|
31
|
+
Ideal when your laptop sleeps often but you want the agent always-on.
|
|
32
|
+
|
|
33
|
+
### Home desktop runs the Gateway
|
|
34
|
+
|
|
35
|
+
The laptop does **not** run the agent. It connects remotely:
|
|
36
|
+
|
|
37
|
+
- Use the macOS app's remote mode (Settings → General → Nodmix runs).
|
|
38
|
+
- The app connects directly when the gateway is reachable on LAN/Tailnet, or opens and manages an SSH tunnel when you choose SSH.
|
|
39
|
+
|
|
40
|
+
Runbook: [macOS remote access](/platforms/mac/remote).
|
|
41
|
+
|
|
42
|
+
### Laptop runs the Gateway
|
|
43
|
+
|
|
44
|
+
Keep the Gateway local but expose it safely:
|
|
45
|
+
|
|
46
|
+
- SSH tunnel to the laptop from other machines, or
|
|
47
|
+
- Tailscale Serve the Control UI and keep the Gateway loopback-only.
|
|
48
|
+
|
|
49
|
+
Guides: [Tailscale](/gateway/tailscale) and [Web overview](/web).
|
|
50
|
+
|
|
51
|
+
## Command flow (what runs where)
|
|
52
|
+
|
|
53
|
+
One gateway service owns state + channels. Nodes are peripherals.
|
|
54
|
+
|
|
55
|
+
Flow example (Telegram → node):
|
|
56
|
+
|
|
57
|
+
- Telegram message arrives at the **Gateway**.
|
|
58
|
+
- Gateway runs the **agent** and decides whether to call a node tool.
|
|
59
|
+
- Gateway calls the **node** over the Gateway WebSocket (`node.*` RPC).
|
|
60
|
+
- Node returns the result; Gateway replies back out to Telegram.
|
|
61
|
+
|
|
62
|
+
Notes:
|
|
63
|
+
|
|
64
|
+
- **Nodes do not run the gateway service.** Only one gateway should run per host unless you intentionally run isolated profiles (see [Multiple gateways](/gateway/multiple-gateways)).
|
|
65
|
+
- macOS app "node mode" is just a node client over the Gateway WebSocket.
|
|
66
|
+
|
|
67
|
+
## SSH tunnel (CLI + tools)
|
|
68
|
+
|
|
69
|
+
Create a local tunnel to the remote Gateway WS:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
ssh -N -L 18789:127.0.0.1:18789 user@host
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
With the tunnel up:
|
|
76
|
+
|
|
77
|
+
- `nodmix health` and `nodmix status --deep` now reach the remote gateway via `ws://127.0.0.1:18789`.
|
|
78
|
+
- `nodmix gateway status`, `nodmix gateway health`, `nodmix gateway probe`, and `nodmix gateway call` can also target the forwarded URL via `--url` when needed.
|
|
79
|
+
|
|
80
|
+
<Note>
|
|
81
|
+
Replace `18789` with your configured `gateway.port` (or `--port` or `NODMIX_GATEWAY_PORT`).
|
|
82
|
+
</Note>
|
|
83
|
+
|
|
84
|
+
<Warning>
|
|
85
|
+
When you pass `--url`, the CLI does not fall back to config or environment credentials. Include `--token` or `--password` explicitly. Missing explicit credentials is an error.
|
|
86
|
+
</Warning>
|
|
87
|
+
|
|
88
|
+
## CLI remote defaults
|
|
89
|
+
|
|
90
|
+
You can persist a remote target so CLI commands use it by default:
|
|
91
|
+
|
|
92
|
+
```json5
|
|
93
|
+
{
|
|
94
|
+
gateway: {
|
|
95
|
+
mode: "remote",
|
|
96
|
+
remote: {
|
|
97
|
+
url: "ws://127.0.0.1:18789",
|
|
98
|
+
token: "your-token",
|
|
99
|
+
},
|
|
100
|
+
},
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
When the gateway is loopback-only, keep the URL at `ws://127.0.0.1:18789` and open the SSH tunnel first.
|
|
105
|
+
In the macOS app's SSH tunnel transport, discovered gateway hostnames belong in
|
|
106
|
+
`gateway.remote.sshTarget`; `gateway.remote.url` remains the local tunnel URL.
|
|
107
|
+
If those ports differ, set `gateway.remote.remotePort` to the gateway port on
|
|
108
|
+
the SSH host.
|
|
109
|
+
|
|
110
|
+
For a gateway already reachable on a trusted LAN or Tailnet, use direct mode:
|
|
111
|
+
|
|
112
|
+
```json5
|
|
113
|
+
{
|
|
114
|
+
gateway: {
|
|
115
|
+
mode: "remote",
|
|
116
|
+
remote: {
|
|
117
|
+
transport: "direct",
|
|
118
|
+
url: "ws://192.168.0.202:18789",
|
|
119
|
+
token: "your-token",
|
|
120
|
+
},
|
|
121
|
+
},
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Credential precedence
|
|
126
|
+
|
|
127
|
+
Gateway credential resolution follows one shared contract across call/probe/status paths and Discord exec-approval monitoring. Node-host uses the same base contract with one local-mode exception (it intentionally ignores `gateway.remote.*`):
|
|
128
|
+
|
|
129
|
+
- Explicit credentials (`--token`, `--password`, or tool `gatewayToken`) always win on call paths that accept explicit auth.
|
|
130
|
+
- URL override safety:
|
|
131
|
+
- CLI URL overrides (`--url`) never reuse implicit config/env credentials.
|
|
132
|
+
- Env URL overrides (`NODMIX_GATEWAY_URL`) may use env credentials only (`NODMIX_GATEWAY_TOKEN` / `NODMIX_GATEWAY_PASSWORD`).
|
|
133
|
+
- Local mode defaults:
|
|
134
|
+
- token: `NODMIX_GATEWAY_TOKEN` -> `gateway.auth.token` -> `gateway.remote.token` (remote fallback applies only when local auth token input is unset)
|
|
135
|
+
- password: `NODMIX_GATEWAY_PASSWORD` -> `gateway.auth.password` -> `gateway.remote.password` (remote fallback applies only when local auth password input is unset)
|
|
136
|
+
- Remote mode defaults:
|
|
137
|
+
- token: `gateway.remote.token` -> `NODMIX_GATEWAY_TOKEN` -> `gateway.auth.token`
|
|
138
|
+
- password: `NODMIX_GATEWAY_PASSWORD` -> `gateway.remote.password` -> `gateway.auth.password`
|
|
139
|
+
- Node-host local-mode exception: `gateway.remote.token` / `gateway.remote.password` are ignored.
|
|
140
|
+
- Remote probe/status token checks are strict by default: they use `gateway.remote.token` only (no local token fallback) when targeting remote mode.
|
|
141
|
+
- Gateway env overrides use `NODMIX_GATEWAY_*` only.
|
|
142
|
+
|
|
143
|
+
## Chat UI remote access
|
|
144
|
+
|
|
145
|
+
WebChat no longer uses a separate HTTP port. The SwiftUI chat UI connects directly to the Gateway WebSocket.
|
|
146
|
+
|
|
147
|
+
- Forward `18789` over SSH (see above), then connect clients to `ws://127.0.0.1:18789`.
|
|
148
|
+
- For LAN/Tailnet direct mode, connect clients to the configured private `ws://` or secure `wss://` URL.
|
|
149
|
+
- On macOS, prefer the app's remote mode, which manages the selected transport automatically.
|
|
150
|
+
|
|
151
|
+
## macOS app remote mode
|
|
152
|
+
|
|
153
|
+
The macOS menu bar app can drive the same setup end-to-end (remote status checks, WebChat, and Voice Wake forwarding).
|
|
154
|
+
|
|
155
|
+
Runbook: [macOS remote access](/platforms/mac/remote).
|
|
156
|
+
|
|
157
|
+
## Security rules (remote/VPN)
|
|
158
|
+
|
|
159
|
+
Short version: **keep the Gateway loopback-only** unless you're sure you need a bind.
|
|
160
|
+
|
|
161
|
+
- **Loopback + SSH/Tailscale Serve** is the safest default (no public exposure).
|
|
162
|
+
- Plaintext `ws://` is accepted for loopback, LAN, link-local, `.local`, `.ts.net`, and Tailscale CGNAT hosts. Public remote hosts must use `wss://`.
|
|
163
|
+
- **Non-loopback binds** (`lan`/`tailnet`/`custom`, or `auto` when loopback is unavailable) must use gateway auth: token, password, or an identity-aware reverse proxy with `gateway.auth.mode: "trusted-proxy"`.
|
|
164
|
+
- `gateway.remote.token` / `.password` are client credential sources. They do **not** configure server auth by themselves.
|
|
165
|
+
- Local call paths can use `gateway.remote.*` as fallback only when `gateway.auth.*` is unset.
|
|
166
|
+
- If `gateway.auth.token` / `gateway.auth.password` is explicitly configured via SecretRef and unresolved, resolution fails closed (no remote fallback masking).
|
|
167
|
+
- `gateway.remote.tlsFingerprint` pins the remote TLS cert when using `wss://`, including macOS direct mode. Without a configured or previously stored pin, macOS only pins a first-use certificate after normal system trust passes; self-signed or private-CA gateways that macOS does not already trust need an explicit fingerprint or Remote over SSH.
|
|
168
|
+
- **Tailscale Serve** can authenticate Control UI/WebSocket traffic via identity
|
|
169
|
+
headers when `gateway.auth.allowTailscale: true`; HTTP API endpoints do not
|
|
170
|
+
use that Tailscale header auth and instead follow the gateway's normal HTTP
|
|
171
|
+
auth mode. This tokenless flow assumes the gateway host is trusted. Set it to
|
|
172
|
+
`false` if you want shared-secret auth everywhere.
|
|
173
|
+
- **Trusted-proxy** auth expects non-loopback identity-aware proxy setups by default.
|
|
174
|
+
Same-host loopback reverse proxies require explicit `gateway.auth.trustedProxy.allowLoopback = true`.
|
|
175
|
+
- Treat browser control like operator access: tailnet-only + deliberate node pairing.
|
|
176
|
+
|
|
177
|
+
Deep dive: [Security](/gateway/security).
|
|
178
|
+
|
|
179
|
+
### macOS: persistent SSH tunnel via LaunchAgent
|
|
180
|
+
|
|
181
|
+
For macOS clients connecting to a remote gateway, the easiest persistent setup uses an SSH `LocalForward` config entry plus a LaunchAgent to keep the tunnel alive across reboots and crashes.
|
|
182
|
+
|
|
183
|
+
#### Step 1: add SSH config
|
|
184
|
+
|
|
185
|
+
Edit `~/.ssh/config`:
|
|
186
|
+
|
|
187
|
+
```ssh
|
|
188
|
+
Host remote-gateway
|
|
189
|
+
HostName <REMOTE_IP>
|
|
190
|
+
User <REMOTE_USER>
|
|
191
|
+
LocalForward 18789 127.0.0.1:18789
|
|
192
|
+
IdentityFile ~/.ssh/id_rsa
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Replace `<REMOTE_IP>` and `<REMOTE_USER>` with your values.
|
|
196
|
+
|
|
197
|
+
#### Step 2: copy SSH key (one-time)
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
ssh-copy-id -i ~/.ssh/id_rsa <REMOTE_USER>@<REMOTE_IP>
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
#### Step 3: configure the gateway token
|
|
204
|
+
|
|
205
|
+
Store the token in config so it persists across restarts:
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
nodmix config set gateway.remote.token "<your-token>"
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
#### Step 4: create the LaunchAgent
|
|
212
|
+
|
|
213
|
+
Save this as `~/Library/LaunchAgents/ai.nodmix.ssh-tunnel.plist`:
|
|
214
|
+
|
|
215
|
+
```xml
|
|
216
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
217
|
+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
218
|
+
<plist version="1.0">
|
|
219
|
+
<dict>
|
|
220
|
+
<key>Label</key>
|
|
221
|
+
<string>ai.nodmix.ssh-tunnel</string>
|
|
222
|
+
<key>ProgramArguments</key>
|
|
223
|
+
<array>
|
|
224
|
+
<string>/usr/bin/ssh</string>
|
|
225
|
+
<string>-N</string>
|
|
226
|
+
<string>remote-gateway</string>
|
|
227
|
+
</array>
|
|
228
|
+
<key>KeepAlive</key>
|
|
229
|
+
<true/>
|
|
230
|
+
<key>RunAtLoad</key>
|
|
231
|
+
<true/>
|
|
232
|
+
</dict>
|
|
233
|
+
</plist>
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
#### Step 5: load the LaunchAgent
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
launchctl bootstrap gui/$UID ~/Library/LaunchAgents/ai.nodmix.ssh-tunnel.plist
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
The tunnel will start automatically at login, restart on crash, and keep the forwarded port live.
|
|
243
|
+
|
|
244
|
+
<Note>
|
|
245
|
+
If you have a leftover `com.nodmix.ssh-tunnel` LaunchAgent from an older setup, unload and delete it.
|
|
246
|
+
</Note>
|
|
247
|
+
|
|
248
|
+
#### Troubleshooting
|
|
249
|
+
|
|
250
|
+
Check if the tunnel is running:
|
|
251
|
+
|
|
252
|
+
```bash
|
|
253
|
+
ps aux | grep "ssh -N remote-gateway" | grep -v grep
|
|
254
|
+
lsof -i :18789
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
Restart the tunnel:
|
|
258
|
+
|
|
259
|
+
```bash
|
|
260
|
+
launchctl kickstart -k gui/$UID/ai.nodmix.ssh-tunnel
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
Stop the tunnel:
|
|
264
|
+
|
|
265
|
+
```bash
|
|
266
|
+
launchctl bootout gui/$UID/ai.nodmix.ssh-tunnel
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
| Config entry | What it does |
|
|
270
|
+
| ------------------------------------ | ------------------------------------------------------------ |
|
|
271
|
+
| `LocalForward 18789 127.0.0.1:18789` | Forwards local port 18789 to remote port 18789 |
|
|
272
|
+
| `ssh -N` | SSH without executing remote commands (port-forwarding only) |
|
|
273
|
+
| `KeepAlive` | Automatically restarts the tunnel if it crashes |
|
|
274
|
+
| `RunAtLoad` | Starts the tunnel when the LaunchAgent loads at login |
|
|
275
|
+
|
|
276
|
+
## Related
|
|
277
|
+
|
|
278
|
+
- [Tailscale](/gateway/tailscale)
|
|
279
|
+
- [Authentication](/gateway/authentication)
|
|
280
|
+
- [Remote gateway setup](/gateway/remote-gateway-readme)
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
summary: "Why a tool is blocked: sandbox runtime, tool allow/deny policy, and elevated exec gates"
|
|
3
|
+
title: Sandbox vs tool policy vs elevated
|
|
4
|
+
read_when: "You hit 'sandbox jail' or see a tool/elevated refusal and want the exact config key to change."
|
|
5
|
+
status: active
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
Nodmix has three related (but different) controls:
|
|
9
|
+
|
|
10
|
+
1. **Sandbox** (`agents.defaults.sandbox.*` / `agents.list[].sandbox.*`) decides **where tools run** (sandbox backend vs host).
|
|
11
|
+
2. **Tool policy** (`tools.*`, `tools.sandbox.tools.*`, `agents.list[].tools.*`) decides **which tools are available/allowed**.
|
|
12
|
+
3. **Elevated** (`tools.elevated.*`, `agents.list[].tools.elevated.*`) is an **exec-only escape hatch** to run outside the sandbox when you're sandboxed (`gateway` by default, or `node` when the exec target is configured to `node`).
|
|
13
|
+
|
|
14
|
+
## Quick debug
|
|
15
|
+
|
|
16
|
+
Use the inspector to see what Nodmix is _actually_ doing:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
nodmix sandbox explain
|
|
20
|
+
nodmix sandbox explain --session agent:main:main
|
|
21
|
+
nodmix sandbox explain --agent work
|
|
22
|
+
nodmix sandbox explain --json
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
It prints:
|
|
26
|
+
|
|
27
|
+
- effective sandbox mode/scope/workspace access
|
|
28
|
+
- whether the session is currently sandboxed (main vs non-main)
|
|
29
|
+
- effective sandbox tool allow/deny (and whether it came from agent/global/default)
|
|
30
|
+
- elevated gates and fix-it key paths
|
|
31
|
+
|
|
32
|
+
## Sandbox: where tools run
|
|
33
|
+
|
|
34
|
+
Sandboxing is controlled by `agents.defaults.sandbox.mode`:
|
|
35
|
+
|
|
36
|
+
- `"off"`: everything runs on the host.
|
|
37
|
+
- `"non-main"`: only non-main sessions are sandboxed (common "surprise" for groups/channels).
|
|
38
|
+
- `"all"`: everything is sandboxed.
|
|
39
|
+
|
|
40
|
+
See [Sandboxing](/gateway/sandboxing) for the full matrix (scope, workspace mounts, images).
|
|
41
|
+
|
|
42
|
+
### Bind mounts (security quick check)
|
|
43
|
+
|
|
44
|
+
- `docker.binds` _pierces_ the sandbox filesystem: whatever you mount is visible inside the container with the mode you set (`:ro` or `:rw`).
|
|
45
|
+
- Default is read-write if you omit the mode; prefer `:ro` for source/secrets.
|
|
46
|
+
- `scope: "shared"` ignores per-agent binds (only global binds apply).
|
|
47
|
+
- Nodmix validates bind sources twice: first on the normalized source path, then again after resolving through the deepest existing ancestor. Symlink-parent escapes do not bypass blocked-path or allowed-root checks.
|
|
48
|
+
- Non-existent leaf paths are still checked safely. If `/workspace/alias-out/new-file` resolves through a symlinked parent to a blocked path or outside the configured allowed roots, the bind is rejected.
|
|
49
|
+
- Binding `/var/run/docker.sock` effectively hands host control to the sandbox; only do this intentionally.
|
|
50
|
+
- Workspace access (`workspaceAccess: "ro"`/`"rw"`) is independent of bind modes.
|
|
51
|
+
|
|
52
|
+
## Tool policy: which tools exist/are callable
|
|
53
|
+
|
|
54
|
+
Two layers matter:
|
|
55
|
+
|
|
56
|
+
- **Tool profile**: `tools.profile` and `agents.list[].tools.profile` (base allowlist)
|
|
57
|
+
- **Provider tool profile**: `tools.byProvider[provider].profile` and `agents.list[].tools.byProvider[provider].profile`
|
|
58
|
+
- **Global/per-agent tool policy**: `tools.allow`/`tools.deny` and `agents.list[].tools.allow`/`agents.list[].tools.deny`
|
|
59
|
+
- **Provider tool policy**: `tools.byProvider[provider].allow/deny` and `agents.list[].tools.byProvider[provider].allow/deny`
|
|
60
|
+
- **Sandbox tool policy** (only applies when sandboxed): `tools.sandbox.tools.allow`/`tools.sandbox.tools.deny` and `agents.list[].tools.sandbox.tools.*`
|
|
61
|
+
|
|
62
|
+
Rules of thumb:
|
|
63
|
+
|
|
64
|
+
- `deny` always wins.
|
|
65
|
+
- If `allow` is non-empty, everything else is treated as blocked.
|
|
66
|
+
- Tool policy is the hard stop: `/exec` cannot override a denied `exec` tool.
|
|
67
|
+
- Tool policy filters tool availability by name; it does not inspect side effects inside `exec`. If `exec` is allowed, denying `write`, `edit`, or `apply_patch` does not make shell commands read-only.
|
|
68
|
+
- `/exec` only changes session defaults for authorized senders; it does not grant tool access.
|
|
69
|
+
Provider tool keys accept either `provider` (e.g. `google-antigravity`) or `provider/model` (e.g. `openai/gpt-5.4`).
|
|
70
|
+
|
|
71
|
+
### Tool groups (shorthands)
|
|
72
|
+
|
|
73
|
+
Tool policies (global, agent, sandbox) support `group:*` entries that expand to multiple tools:
|
|
74
|
+
|
|
75
|
+
```json5
|
|
76
|
+
{
|
|
77
|
+
tools: {
|
|
78
|
+
sandbox: {
|
|
79
|
+
tools: {
|
|
80
|
+
allow: ["group:runtime", "group:fs", "group:sessions", "group:memory"],
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Available groups:
|
|
88
|
+
|
|
89
|
+
- `group:runtime`: `exec`, `process`, `code_execution` (`bash` is accepted as
|
|
90
|
+
an alias for `exec`)
|
|
91
|
+
- `group:fs`: `read`, `write`, `edit`, `apply_patch`
|
|
92
|
+
For read-only agents, deny `group:runtime` as well as mutating filesystem tools unless sandbox filesystem policy or a separate host boundary enforces the read-only constraint.
|
|
93
|
+
- `group:sessions`: `sessions_list`, `sessions_history`, `sessions_send`, `sessions_spawn`, `sessions_yield`, `subagents`, `session_status`
|
|
94
|
+
- `group:memory`: `memory_search`, `memory_get`
|
|
95
|
+
- `group:web`: `web_search`, `x_search`, `web_fetch`
|
|
96
|
+
- `group:ui`: `browser`, `canvas`
|
|
97
|
+
- `group:automation`: `heartbeat_respond`, `cron`, `gateway`
|
|
98
|
+
- `group:messaging`: `message`
|
|
99
|
+
- `group:nodes`: `nodes`
|
|
100
|
+
- `group:agents`: `agents_list`, `update_plan`
|
|
101
|
+
- `group:media`: `image`, `image_generate`, `music_generate`, `video_generate`, `tts`
|
|
102
|
+
- `group:nodmix`: all built-in Nodmix tools (excludes provider plugins)
|
|
103
|
+
- `group:plugins`: all loaded plugin-owned tools, including configured MCP servers exposed through `bundle-mcp`
|
|
104
|
+
|
|
105
|
+
For sandboxed MCP servers, the sandbox tool policy is a second allow gate. If `mcp.servers` is configured but sandboxed turns only show built-in tools, add `bundle-mcp`, `group:plugins`, or a server-prefixed MCP tool name/glob such as `outlook__send_mail` or `outlook__*` to `tools.sandbox.tools.alsoAllow`, then restart/reload the gateway and recapture the tool list. Server globs use the provider-safe MCP server prefix: non-`[A-Za-z0-9_-]` characters become `-`, names that do not start with a letter get an `mcp-` prefix, and long or duplicate prefixes may be truncated or suffixed.
|
|
106
|
+
|
|
107
|
+
`nodmix doctor` currently checks this shape for Nodmix-managed servers in `mcp.servers`. MCP servers loaded from bundled plugin manifests or Claude `.mcp.json` use the same sandbox gate, but this diagnostic does not enumerate those sources yet; use the same allowlist entries if their tools disappear in sandboxed turns.
|
|
108
|
+
|
|
109
|
+
## Elevated: exec-only "run on host"
|
|
110
|
+
|
|
111
|
+
Elevated does **not** grant extra tools; it only affects `exec`.
|
|
112
|
+
|
|
113
|
+
- If you're sandboxed, `/elevated on` (or `exec` with `elevated: true`) runs outside the sandbox (approvals may still apply).
|
|
114
|
+
- Use `/elevated full` to skip exec approvals for the session.
|
|
115
|
+
- If you're already running direct, elevated is effectively a no-op (still gated).
|
|
116
|
+
- Elevated is **not** skill-scoped and does **not** override tool allow/deny.
|
|
117
|
+
- Elevated does not grant arbitrary cross-host overrides from `host=auto`; it follows the normal exec target rules and only preserves `node` when the configured/session target is already `node`.
|
|
118
|
+
- `/exec` is separate from elevated. It only adjusts per-session exec defaults for authorized senders.
|
|
119
|
+
|
|
120
|
+
Gates:
|
|
121
|
+
|
|
122
|
+
- Enablement: `tools.elevated.enabled` (and optionally `agents.list[].tools.elevated.enabled`)
|
|
123
|
+
- Sender allowlists: `tools.elevated.allowFrom.<provider>` (and optionally `agents.list[].tools.elevated.allowFrom.<provider>`)
|
|
124
|
+
|
|
125
|
+
See [Elevated Mode](/tools/elevated).
|
|
126
|
+
|
|
127
|
+
## Common "sandbox jail" fixes
|
|
128
|
+
|
|
129
|
+
### "Tool X blocked by sandbox tool policy"
|
|
130
|
+
|
|
131
|
+
Fix-it keys (pick one):
|
|
132
|
+
|
|
133
|
+
- Disable sandbox: `agents.defaults.sandbox.mode=off` (or per-agent `agents.list[].sandbox.mode=off`)
|
|
134
|
+
- Allow the tool inside sandbox:
|
|
135
|
+
- remove it from `tools.sandbox.tools.deny` (or per-agent `agents.list[].tools.sandbox.tools.deny`)
|
|
136
|
+
- or add it to `tools.sandbox.tools.allow` (or per-agent allow)
|
|
137
|
+
|
|
138
|
+
### "I thought this was main, why is it sandboxed?"
|
|
139
|
+
|
|
140
|
+
In `"non-main"` mode, group/channel keys are _not_ main. Use the main session key (shown by `sandbox explain`) or switch mode to `"off"`.
|
|
141
|
+
|
|
142
|
+
## Related
|
|
143
|
+
|
|
144
|
+
- [Sandboxing](/gateway/sandboxing) -- full sandbox reference (modes, scopes, backends, images)
|
|
145
|
+
- [Multi-Agent Sandbox & Tools](/tools/multi-agent-sandbox-tools) -- per-agent overrides and precedence
|
|
146
|
+
- [Elevated Mode](/tools/elevated)
|