mirror of
https://github.com/openclaw/openclaw.git
synced 2026-02-09 05:19:32 +08:00
* docs: restructure Get Started tab and improve onboarding flow - Flatten nested Onboarding group into linear First Steps flow - Add 'What is OpenClaw?' narrative section to landing page - Split wizard.md into streamlined overview + full reference (reference/wizard.md) - Move Pairing to Channels > Configuration - Move Bootstrapping to Agents > Fundamentals - Move macOS app onboarding to Platforms > macOS companion app - Move Lore to Help > Community - Remove duplicate install instructions from openclaw.md - Mirror navigation changes in zh-CN tabs - No content deleted — all detail preserved or relocated * docs: move deployment pages to install/, fix Platforms tab routing, clarify onboarding paths - Move deployment guides (fly, hetzner, gcp, macos-vm, exe-dev, railway, render, northflank) from platforms/ and root to install/ - Add 'Hosting and deployment' group to Install tab - Slim Gateway & Ops 'Remote access and deployment' down to 'Remote access' - Swap Platforms tab before Gateway & Ops to fix path-prefix routing - Move macOS app onboarding into First steps (parallel to CLI wizard) - Rename sidebar titles to 'Onboarding: CLI' / 'Onboarding: macOS App' - Add redirects for all moved paths - Update all internal links (en + zh-CN) - Fix img tag syntax in onboarding.md
95 lines
1.9 KiB
Markdown
95 lines
1.9 KiB
Markdown
---
|
|
summary: "Linux support + companion app status"
|
|
read_when:
|
|
- Looking for Linux companion app status
|
|
- Planning platform coverage or contributions
|
|
title: "Linux App"
|
|
---
|
|
|
|
# Linux App
|
|
|
|
The Gateway is fully supported on Linux. **Node is the recommended runtime**.
|
|
Bun is not recommended for the Gateway (WhatsApp/Telegram bugs).
|
|
|
|
Native Linux companion apps are planned. Contributions are welcome if you want to help build one.
|
|
|
|
## Beginner quick path (VPS)
|
|
|
|
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)
|
|
|
|
## Install
|
|
|
|
- [Getting Started](/start/getting-started)
|
|
- [Install & updates](/install/updating)
|
|
- Optional flows: [Bun (experimental)](/install/bun), [Nix](/install/nix), [Docker](/install/docker)
|
|
|
|
## Gateway
|
|
|
|
- [Gateway runbook](/gateway)
|
|
- [Configuration](/gateway/configuration)
|
|
|
|
## Gateway service install (CLI)
|
|
|
|
Use one of these:
|
|
|
|
```
|
|
openclaw onboard --install-daemon
|
|
```
|
|
|
|
Or:
|
|
|
|
```
|
|
openclaw gateway install
|
|
```
|
|
|
|
Or:
|
|
|
|
```
|
|
openclaw configure
|
|
```
|
|
|
|
Select **Gateway service** when prompted.
|
|
|
|
Repair/migrate:
|
|
|
|
```
|
|
openclaw doctor
|
|
```
|
|
|
|
## System control (systemd user unit)
|
|
|
|
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:
|
|
|
|
Create `~/.config/systemd/user/openclaw-gateway[-<profile>].service`:
|
|
|
|
```
|
|
[Unit]
|
|
Description=OpenClaw Gateway (profile: <profile>, v<version>)
|
|
After=network-online.target
|
|
Wants=network-online.target
|
|
|
|
[Service]
|
|
ExecStart=/usr/local/bin/openclaw gateway --port 18789
|
|
Restart=always
|
|
RestartSec=5
|
|
|
|
[Install]
|
|
WantedBy=default.target
|
|
```
|
|
|
|
Enable it:
|
|
|
|
```
|
|
systemctl --user enable --now openclaw-gateway[-<profile>].service
|
|
```
|