nodmix 2026.5.25

package/docs/install/exe-dev.md

@@ -0,0 +1,201 @@
+---
+summary: "Run Nodmix Gateway on exe.dev (VM + HTTPS proxy) for remote access"
+read_when:
+  - You want a cheap always-on Linux host for the Gateway
+  - You want remote Control UI access without running your own VPS
+title: "exe.dev"
+---
+
+Goal: Nodmix Gateway running on an exe.dev VM, reachable from your laptop via: `https://<vm-name>.exe.xyz`
+
+This page assumes exe.dev's default **exeuntu** image. If you picked a different distro, map packages accordingly.
+
+## Beginner quick path
+
+1. [https://exe.new/nodmix](https://exe.new/nodmix)
+2. Fill in your auth key/token as needed
+3. Click on "Agent" next to your VM and wait for Shelley to finish provisioning
+4. Open `https://<vm-name>.exe.xyz/` and authenticate with the configured shared secret (this guide uses token auth by default, but password auth works too if you switch `gateway.auth.mode`)
+5. Approve any pending device pairing requests with `nodmix devices approve <requestId>`
+
+## What you need
+
+- exe.dev account
+- `ssh exe.dev` access to [exe.dev](https://exe.dev) virtual machines (optional)
+
+## Automated install with Shelley
+
+Shelley, [exe.dev](https://exe.dev)'s agent, can install Nodmix instantly with our
+prompt. The prompt used is as below:
+
+```
+Set up Nodmix (https://docs.nodmix.ai/install) on this VM. Use the non-interactive and accept-risk flags for nodmix onboarding. Add the supplied auth or token as needed. Configure nginx to forward from the default port 18789 to the root location on the default enabled site config, making sure to enable Websocket support. Pairing is done by "nodmix devices list" and "nodmix devices approve <request id>". Make sure the dashboard shows that Nodmix's health is OK. exe.dev handles forwarding from port 8000 to port 80/443 and HTTPS for us, so the final "reachable" should be <vm-name>.exe.xyz, without port specification.
+```
+
+## Manual installation
+
+## 1) Create the VM
+
+From your device:
+
+```bash
+ssh exe.dev new
+```
+
+Then connect:
+
+```bash
+ssh <vm-name>.exe.xyz
+```
+
+<Tip>
+Keep this VM **stateful**. Nodmix stores `nodmix.json`, per-agent `auth-profiles.json`, sessions, and channel/provider state under `~/.nodmix/`, plus the workspace under `~/.nodmix/workspace/`.
+</Tip>
+
+## 2) Install prerequisites (on the VM)
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git curl jq ca-certificates openssl
+```
+
+## 3) Install Nodmix
+
+Run the Nodmix install script:
+
+```bash
+curl -fsSL https://nodmix.ai/install.sh | bash
+```
+
+## 4) Setup nginx to proxy Nodmix to port 8000
+
+Edit `/etc/nginx/sites-enabled/default` with
+
+```
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
+    listen 8000;
+    listen [::]:8000;
+
+    server_name _;
+
+    location / {
+        proxy_pass http://127.0.0.1:18789;
+        proxy_http_version 1.1;
+
+        # WebSocket support
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+
+        # Standard proxy headers
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $remote_addr;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        # Timeout settings for long-lived connections
+        proxy_read_timeout 86400s;
+        proxy_send_timeout 86400s;
+    }
+}
+```
+
+Overwrite forwarding headers instead of preserving client-supplied chains.
+Nodmix trusts forwarded IP metadata only from explicitly configured proxies,
+and append-style `X-Forwarded-For` chains are treated as a hardening risk.
+
+## 5) Access Nodmix and grant privileges
+
+Access `https://<vm-name>.exe.xyz/` (see the Control UI output from onboarding). If it prompts for auth, paste the
+configured shared secret from the VM. This guide uses token auth, so retrieve `gateway.auth.token`
+with `nodmix config get gateway.auth.token` (or generate one with `nodmix doctor --generate-gateway-token`).
+If you changed the gateway to password auth, use `gateway.auth.password` / `NODMIX_GATEWAY_PASSWORD` instead.
+Approve devices with `nodmix devices list` and `nodmix devices approve <requestId>`. When in doubt, use Shelley from your browser!
+
+## Remote channel setup
+
+For remote hosts, prefer one `config patch` call over many SSH calls to `config set`. Keep real tokens in the VM environment or `~/.nodmix/.env`, and put only SecretRefs in `nodmix.json`.
+
+On the VM, make the service environment contain the secrets it needs:
+
+```bash
+cat >> ~/.nodmix/.env <<'EOF'
+SLACK_BOT_TOKEN=xoxb-...
+SLACK_APP_TOKEN=xapp-...
+DISCORD_BOT_TOKEN=...
+OPENAI_API_KEY=sk-...
+EOF
+```
+
+From your local machine, create a patch file and pipe it to the VM:
+
+```json5
+// nodmix.remote.patch.json5
+{
+  secrets: {
+    providers: {
+      default: { source: "env" },
+    },
+  },
+  channels: {
+    slack: {
+      enabled: true,
+      mode: "socket",
+      botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" },
+      appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" },
+      groupPolicy: "open",
+      requireMention: false,
+    },
+    discord: {
+      enabled: true,
+      token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" },
+      dmPolicy: "disabled",
+      dm: { enabled: false },
+      groupPolicy: "allowlist",
+    },
+  },
+  agents: {
+    defaults: {
+      model: { primary: "openai/gpt-5.5" },
+      models: {
+        "openai/gpt-5.5": { params: { fastMode: true } },
+      },
+    },
+  },
+}
+```
+
+```bash
+ssh <vm-name>.exe.xyz 'nodmix config patch --stdin --dry-run' < ./nodmix.remote.patch.json5
+ssh <vm-name>.exe.xyz 'nodmix config patch --stdin' < ./nodmix.remote.patch.json5
+ssh <vm-name>.exe.xyz 'nodmix gateway restart && nodmix health'
+```
+
+Use `--replace-path` when a nested allowlist should become exactly the patch value, for example when replacing a Discord channel allowlist:
+
+```bash
+ssh <vm-name>.exe.xyz 'nodmix config patch --stdin --replace-path "channels.discord.guilds[\"123\"].channels"' < ./discord.patch.json5
+```
+
+## Remote access
+
+Remote access is handled by [exe.dev](https://exe.dev)'s authentication. By
+default, HTTP traffic from port 8000 is forwarded to `https://<vm-name>.exe.xyz`
+with email auth.
+
+## Updating
+
+```bash
+npm i -g nodmix@latest
+nodmix doctor
+nodmix gateway restart
+nodmix health
+```
+
+Guide: [Updating](/install/updating)
+
+## Related
+
+- [Remote gateway](/gateway/remote)
+- [Install overview](/install)