Files

95 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2026-01-05 20:59:54 +01:00
---
2026-01-07 21:37:05 +01:00
summary: "Linux support + companion app status"
2026-01-05 20:59:54 +01:00
read_when:
- Looking for Linux companion app status
- Planning platform coverage or contributions
title: "Linux App"
2026-01-05 20:59:54 +01:00
---
2026-01-31 21:13:13 +09:00
2026-01-05 20:59:54 +01:00
# Linux App
2026-01-13 07:58:47 +00:00
The Gateway is fully supported on Linux. **Node is the recommended runtime**.
Bun is not recommended for the Gateway (WhatsApp/Telegram bugs).
2026-01-05 20:59:54 +01:00
Native Linux companion apps are planned. Contributions are welcome if you want to help build one.
2026-01-07 21:37:05 +01:00
## Beginner quick path (VPS)
2026-01-31 21:13:13 +09:00
1. Install Node 22+
2. `npm i -g openclaw@latest`
3. `openclaw onboard --install-daemon`
4. From your laptop: `ssh -N -L 18789:127.0.0.1:18789 <user>@<host>`
5. Open `http://127.0.0.1:18789/` and paste your token
Step-by-step VPS guide: [exe.dev](/install/exe-dev)
2026-01-07 21:37:05 +01:00
## Install
2026-01-31 21:13:13 +09:00
2026-01-07 21:37:05 +01:00
- [Getting Started](/start/getting-started)
- [Install & updates](/install/updating)
2026-01-13 07:58:47 +00:00
- Optional flows: [Bun (experimental)](/install/bun), [Nix](/install/nix), [Docker](/install/docker)
2026-01-07 21:37:05 +01:00
## Gateway
2026-01-31 21:13:13 +09:00
2026-01-07 21:37:05 +01:00
- [Gateway runbook](/gateway)
- [Configuration](/gateway/configuration)
## Gateway service install (CLI)
Use one of these:
```
2026-01-30 03:15:10 +01:00
openclaw onboard --install-daemon
2026-01-07 21:37:05 +01:00
```
Or:
```
2026-01-30 03:15:10 +01:00
openclaw gateway install
2026-01-07 21:37:05 +01:00
```
Or:
```
2026-01-30 03:15:10 +01:00
openclaw configure
2026-01-07 21:37:05 +01:00
```
2026-01-21 17:45:12 +00:00
Select **Gateway service** when prompted.
2026-01-07 21:37:05 +01:00
Repair/migrate:
```
2026-01-30 03:15:10 +01:00
openclaw doctor
2026-01-07 21:37:05 +01:00
```
## System control (systemd user unit)
2026-01-31 21:13:13 +09:00
2026-01-30 03:15:10 +01:00
OpenClaw installs a systemd **user** service by default. Use a **system**
service for shared or always-on servers. The full unit example and guidance
live in the [Gateway runbook](/gateway).
Minimal setup:
2026-01-07 21:37:05 +01:00
2026-01-30 03:15:10 +01:00
Create `~/.config/systemd/user/openclaw-gateway[-<profile>].service`:
2026-01-07 21:37:05 +01:00
```
[Unit]
2026-01-30 03:15:10 +01:00
Description=OpenClaw Gateway (profile: <profile>, v<version>)
2026-01-07 21:37:05 +01:00
After=network-online.target
Wants=network-online.target
[Service]
2026-01-30 03:15:10 +01:00
ExecStart=/usr/local/bin/openclaw gateway --port 18789
2026-01-07 21:37:05 +01:00
Restart=always
RestartSec=5
[Install]
WantedBy=default.target
```
Enable it:
```
2026-01-30 03:15:10 +01:00
systemctl --user enable --now openclaw-gateway[-<profile>].service
2026-01-07 21:37:05 +01:00
```