Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openaeon.ai/llms.txt

Use this file to discover all available pages before exploring further.

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 openaeon@latest
  3. openaeon 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

Gateway

Gateway service install (CLI)

Use one of these:
openaeon onboard --install-daemon
Or:
openaeon gateway install
Or:
openaeon configure
Select Gateway service when prompted. Repair/migrate:
openaeon doctor

System control (systemd user unit)

OpenAEON 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. Minimal setup: Create ~/.config/systemd/user/openaeon-gateway[-<profile>].service:
[Unit]
Description=OpenAEON Gateway (profile: <profile>, v<version>)
After=network-online.target
Wants=network-online.target

[Service]
ExecStart=/usr/local/bin/openaeon gateway --port 18789
Restart=always
RestartSec=5

[Install]
WantedBy=default.target
Enable it:
systemctl --user enable --now openaeon-gateway[-<profile>].service