Files
openclaw/docs/install/upstash.md
2026-08-17 17:01:23 -07:00

104 lines
2.7 KiB
Markdown

---
summary: "Host OpenClaw on Upstash Box with keep-alive and SSH tunnel access"
read_when:
- Deploying OpenClaw to Upstash Box
- You want a managed Linux environment for OpenClaw with SSH-tunneled dashboard access
title: "Upstash Box"
---
Run a persistent OpenClaw Gateway on Upstash Box, a managed Linux environment
with keep-alive lifecycle support.
Use an SSH tunnel for dashboard access. Do not expose the Gateway port directly
to the public internet.
## Prerequisites
- Upstash account
- Keep-alive Upstash Box
- SSH client on your local machine
## Create a Box
Create a keep-alive Box in the Upstash Console. Note the Box ID (for example
`right-flamingo-14486`) and your Box API key.
Upstash maintains its current OpenClaw Box walkthrough at
[OpenClaw Setup](https://upstash.com/docs/box/guides/openclaw-setup).
## Connect with an SSH tunnel
Forward the OpenClaw dashboard port to your local machine. Use your Box API key
as the SSH password when prompted:
```bash
ssh -o ServerAliveInterval=15 -o ServerAliveCountMax=3 -L 18789:127.0.0.1:18789 <box-id>@us-east-1.box.upstash.com
```
The keepalive options reduce idle tunnel drops during onboarding.
## Install OpenClaw
Inside the Box, use the following command on npm 12 or npm 11.16+. On npm 11.15
and earlier, omit `--allow-scripts=openclaw`.
```bash
sudo npm install -g openclaw --allow-scripts=openclaw
```
## Run onboarding
```bash
openclaw onboard --no-install-daemon
```
Follow the prompts. Copy the dashboard URL and token when onboarding finishes.
## Start the Gateway
Keep the Gateway on loopback for the SSH tunnel, then start one unsupervised
process in the background:
```bash
openclaw config set gateway.bind loopback
nohup openclaw gateway run > gateway.log 2>&1 &
openclaw doctor --json
```
With the SSH tunnel active, open the dashboard URL locally:
```text
http://127.0.0.1:18789/#token=<your-token>
```
## Auto-restart
Set this command as the Box init script so the Gateway restarts when the Box
starts:
```bash
nohup openclaw gateway run > gateway.log 2>&1 &
```
Onboarding deliberately skips daemon installation in this guide. The Box init
script is the single owner of Gateway startup, so two processes do not contend
for the same lock and port.
## Troubleshooting
If SSH freezes during onboarding, reconnect with a clean SSH config and
keepalives:
```bash
ssh -F /dev/null -o ControlMaster=no -o ServerAliveInterval=15 -o ServerAliveCountMax=3 -L 18789:127.0.0.1:18789 <box-id>@us-east-1.box.upstash.com
```
This bypasses stale local `~/.ssh/config` settings and keeps the tunnel active
through idle network periods.
## Related
- [Remote access](/gateway/remote)
- [Gateway security](/gateway/security)
- [Updating OpenClaw](/install/updating)